草庐IT

c++ - 用于多语言 API 的 Doxygen

我的公司为工程程序开发API。它是用C++开发的,但我们为以下语言创建了包装器:类似于VB的专有语言MATLAB和Python。目前,文档是由一堆脚本生成的,要保持100%的完整性开始变得很耗时。我想知道是否有办法让doxygen/sphinx或其他程序一次性生成C/C++、VB和MATLAB的文档。Python部分由SWIG完成。目前的输出是这样的:职能名称VB:函数NameOfFunction(ByValaAsLong,ByRefb()AsLong,ByValcAsLong)AsLongMATLAB:value=NameOfFunction(a,b(),c)C/C++:值*Name

c++ - Doxygen - 将参数声明为可选

我正在使用Doxygen记录一个代码库,想知道是否有一个关键字用于将函数的参数声明为可选。像这样的东西:/*!\fnintadd(inta,intb=0)\briefaddstwovalues\paramathefirstoperand\param\optionalbthesecondoperand.Defaultis0\returntheresult*/这似乎是应该存在的东西,但我一直无法在任何地方找到它。是否有实际的选项,或者我只需要在描述中注明? 最佳答案 回答您的问题:不,没有这样的事情。但我不同意你认为应该有这样的东西。毕

c++ - 带有 Doxygen (C++) 的模板类中的 typedef

我的问题是关于如何使用Doxygen在模板类中注释typedef。我将举一个例子来说明我的问题:namespacefundamental{/***Basicfunction*/templateclassBase{public:Tx;///Coordinate;///使用Doxygen处理以上代码后,我可以得到一个HTML页面来显示类Base的定义。但是对于typedef类Coordinate,它不会和Base出现在同一个页面中。事实上,所有typedef类型都列在基本命名空间页面中,连同该命名空间中的所有类。我想知道是否可以在基本HTML页面中显示坐标类。通过这样做,Base和Coor

c++ - Doxygen -- 多个函数的单个注释 block

你能在doxygen中使用一个注释block来注释多个函数吗?下面是一个不起作用的简单示例。我可以做类似的事情来得到我想要的吗?文件.cpp#includefile.h///@nameFunsGroupedInDoxygen///@{/***@briefDocumentationfor2functions*@paramaParamAParameter*@retval0willalwaysbereturned*/intfun1(intaParam){return0;}intfun2(intaParam){return0;}///@}文件.hintfun1(intaParam);intfu

c++ - Doxygen 隐藏源文件

我刚开始使用Doxygen为我的库生成文档,我发现了一个我无法解决的小故障。在TreeView中有文件列表,您可以单击其中一个文件,然后获取源代码。我找到了摆脱文件列表的方法,但后来我再也看不到枚举了。你知道对Doxygen隐藏源代码的方法吗?此外,如果您转到badaAPIreference您将在TreeView中看到没有类列表或类成员的网站。只有包含类的命名空间列表。我可以修改Doxygen来做同样的事情吗? 最佳答案 我对doxygen比较陌生,但禁用SHOW_FILES和VERBATIM_HEADERS选项似乎可以摆脱源代码列

c++ - 如何用 doxygen 记录一个函数对象?

我应该如何用doxygen记录一个函数对象(又名仿函数)?仅将其记录为常规类(class)感觉会产生误导。我发现将函数对象视为具有闭包的函数要比将其视为可调用类要好得多。有没有办法记录符合我偏好的函数对象?classAdder{public:Adder(size_tx):m_x(x){}size_toperator()(size_ty)const{returnm_x+y;}private:constsize_tm_x;}; 最佳答案 给它类文档,将单词functor放在第一句(最好是第一个单词),如果意思很明显,则跳过operato

c++ - 如何去掉doxygen协作图中的 "size_t"

Doxygen(v1.8.11)创建漂亮的UML协作图。不错,除了被汇集到“size_t”的行弄得乱七八糟。形式上正确,但完全没用。有没有办法防止“size_t”出现在聚合类中? 最佳答案 在您的Doxygen配置文件中将size_t放在EXCLUDE_SYMBOLS下。http://www.doxygen.nl/config.html#cfg_exclude_symbols 关于c++-如何去掉doxygen协作图中的"size_t",我们在StackOverflow上找到一个类似的问

c++ - 如何在 Doxygen 内联代码中转义特殊命令

我想在Doxygen注释中使用内联代码:Use`#define`forsomething..产生以下警告:warning:explicitlinkrequestto'define'couldnotberesolved如何转义#符号以忽略此警告?如果我像这样使用反斜杠(\):Use`\#define`forsomething..我仍然收到相同的警告.. 最佳答案 我遇到了类似的警告,但上下文略有不同。我想看"#includefoo"(以等宽字体引用)而不是#define在生成的文档中。什么不起作用doxygen支持markdown表明

c++ - 我如何强制 Doxygen 显示完整的包含路径?

如何强制Doxygen显示完整的包含路径?什么意思:我有一个类foo::bar::bee在bee.hpp中定义在以下目录结构中:foofoo/barfoo/bar/bee.hppDoxygen,当它记录foo::bar::bee时类告诉你需要包括,但对于我的软件,我需要我怎样才能让Doxygen这样做呢?是否有任何选项可以提供像“-I”这样的“包含标志”,以便doxygen知道基地在哪里?注意事项:FULL_PATH_NAMES已设置为默认值YES我不想为每个类显式提供包含header,因为他们太多了。我希望Doxygen自动执行此操作。谢谢。回答设置:STRIP_FROM_INC_P

c++ - 如何将非成员函数与 Doxygen 中的类相关联?

我确信有一些方法可以用\defgroup、\addgroup和\@{\@}标签来做到这一点,但经过几个小时的试验和(显然)错误,我问SO.....我有:classC{public:voidfoo()const;};我有一些帮助非成员函数,它们确实是C接口(interface)的一部分,但不在类中:std::stringformat(constC&c,conststd::string&fmt);我希望格式函数与类函数出现在同一页面上。那是不可能的吗?我能做的最好的是“模块”页面,它将C列为一个类(带有指向C注释的超链接,并将格式设置为函数? 最佳答案