仅为stl容器中的自定义类提供Doxygen支持

时间:2014-04-07 12:44:26

标签: c++ stl doxygen

我刚开始使用doxygen并发现了非常有用的配置:

BUILTIN_STL_SUPPORT = YES

我想知道的是,是否有任何方法可以限制此范围? (不是范围的C ++技术含义,而是doxygen的理解范围。)特别是在包装自定义类时出现STL容器会很棒。例如,如果我有以下内容:

class B;
class A
{
    std::vector<char> vectorOfChar;
    std::vector<B> vectorOfObjects;
};

如果没有出现vector<B>,doxygen会在协作图中显示vector<char>会很棒。是否可以使用配置选项或自定义头文件,或修改内置的stl支持?

1 个答案:

答案 0 :(得分:0)

根据您项目的规模,我可以考虑为您的案例进行2次解决,两者都不是最佳的:

  • 只有少数几个应显示STL对象的实例:您可以在此删除BUILTIN_STL_SUPPORT标记并记录您想要查看的每个符号。例如,您记录了std::vector<B>类型。

  • 应该显示很多stl类型,只删除默认类型:在这里,您可以使用EXCLUDE_SYMBOLS排除符号。您可以为示例排除std::vector<char>,它不会显示在依赖关系图中。这可能是很多工作,但您可以使用通配符进行泛化。

不幸的是,两者都不是非常方便的解决方案,但也许它总比没有好。

链接:http://cs.swan.ac.uk/~csoliver/ok-sat-library/internet_html/doc/doc/Doxygen/1.7.6.1/html/config.html#cfg_exclude_symlinks