Tag: doxygen

自定义标签与Doxygen

我想弄清楚是否有办法使用Doxygen创build自定义标签。 我find了ALIASconfiguration文件选项,但是这并不完全符合我的需要。 基本上在我的代码中,我想能够写出类似的东西 /// \req Requirement #322 – blah blah 然后让Doxygen创build一个类似于\bug和\todo命令的列表,该列表具有这个自定义标签。 这可能与Doxygen?

如何在Doxygen中包含自定义文件

我想添加自定义(非项目)文件来与Doxygen生成一些额外的页面。 我(实际上)不确定如何命名这些文件以及如何格式化它们的内容。

不包括Doxygen的目录

我想Doxygen忽略,绕过,而不是search我的项目的以下目录: */.svn/* */docs/* */Properties/* */bin/* 根据Doxygen常见问题 : How can I exclude all test directories from my directory tree? Simply put an exclude pattern like this in the configuration file: EXCLUDE_PATTERNS = */test/* 所以,我的Doxygen文件看起来像这样: # If the value of the INPUT tag contains directories, you can use the # EXCLUDE_PATTERNS tag to specify one or more […]

Graphviz + Doxygen来生成UML类图

我想用Graphviz + Doxygen生成一个基于C ++代码的类图。 Doxygen本身就具有本地DOT支持; 但是有可能产生一个类似于下面的图表的带有相应访问修改器(public,private等)的类UML输出 ,类方法的返回和参数types? 我知道线程如何使用doxygen从C ++源创buildUML类图 ,但是它并没有回答这个问题。

如何使用doxygen编写C ++模板和模板元函数?

有没有关于如何使用DoxygenloggingC ++模板和模板元函数的指南? 例如: /// @brief metafunction for generation of a map of message types to /// their associated callbacks. /// @tparam Seq the list of message types template< class Seq > struct generate_callback_map { typedef typename mpl::transform< Seq , build_type_signature_pair< mpl::_1 > >::type vector_pair_type; typedef typename fusion::result_of::as_map< vector_pair_type >::type type; }; 到目前为止,我已经看到了以下build议: @tparam用于logging模板参数。 @arg替代模板参数的备选方法。 @brief用来描述元函数。 […]

logging从C#中使用的C ++ / CLI库代码 – 最好的工具和实践?

我正在从事一个项目,主要从ac#应用程序中使用c ++ / cli库。 有没有什么办法使c ++ / cli中的代码注释可视化到Visual Studio中的c#intellisence? 假设没有,最好的方式来logging的c + + / cli代码,以使其更容易从c#中使用(当然在c + + / cli当然)? 你对XML评论和doxygen vs其他工具(哪些)有什么看法?

为什么C的评论像/ * * /需要'<'?

我的团队C代码指导方针写道,最好在如下所示的注释中放置一个“<”: #define MAX_PACK_ITEM_NUM 50 /**< max number of item */ 我想知道这个“<”的真正用途是什么?

Doxygen \ cite产生空的书目

我正尝试在Doxygen中\cite参考文献,并在我的文章中提供参考。 我在searchpath和正确的.bib文件bibtex。 我已将.bib文件添加到CITE_BIB_FILES并使用.bib文件中find的正确的BibTex标签。 Doxygen正在创build一个书目页面,但它是空的。 它也在文档文本中创build引用链接,但链接也是空的。 任何想法我怎么能得到引用信息显示?

我可以使用doxygen编写Python代码吗(这是否合理)?

我喜欢doxygen来创buildC或PHP代码的文档。 我有一个即将到来的Python项目,我想我记得Python没有/ * .. * /注释,也有自己的自我文档设施,这似乎是Python文档的方式。 我可以只使用doxygen吗? 有什么特别需要注意的? 我已经在Python中做了一些编码,但到目前为止,只在我懒得logging的小项目上(是的,我知道…但现在我们假装没问题)。

多克辛vs Javadoc

我刚刚从CACM的一篇文章中认识到,Doxygen也可以和Java(以及其他几种语言)一起工作。 但是Java已经有了Javadoc工具。 有人可以解释两种方法的优缺点吗? 它们是相互排斥的吗? 有Doxygen的Maven插件吗?