关注
分享
文章平均质量分 92
Doxygen 是一个程序代码的说明文档生成工具，可将代码中按特定规范的注释转换为说明文档，支持C、C++、Java、Objective-C和IDL语言等多种语言。Doxygen可以从一套归档源文件开始，生成HTML格式的在线类浏览器，或离线的LATEX、RTF参考手册。
丸子叮咚响
日拱一卒，功不唐捐。
展开
-
Doxygen 注释list
一 常规方式By putting a number of column-aligned minus (-) signs at the start of a line, a bullet list will automatically be generated. Instead of the minus sign also plus (+) or asterisk (*) can be use...原创 2019-05-20 20:20:49 · 385 阅读 · 0 评论 -
Doxygen 全局对象注释
一 官网AttentionLet's repeat that, because it is often overlooked: to document global objects (functions, typedefs, enum, macros, etc), youmustdocument the file in which they are defined. In other wo...原创 2019-05-17 09:24:05 · 511 阅读 · 0 评论 -
Doxygen 函数注释
一 democlass FunctionDemo{ public: /** * @brief func是一个普通成员函数 * * @param a [in] param a * @param b [in, out] param b * @param c [out] output * @return int * @retval * 1...原创 2019-05-16 20:18:48 · 2498 阅读 · 0 评论 -
Doxygen 文件注释
一 Doxygen命令Doxygen命令列表http://www.doxygen.nl/manual/commands.html二 文件注释// Doxygen文件注释常用命令// demo.hpp/** * @file demo.hpp * @brief 这是一个doxygen demo 示例 * @details * -# 这是第一点 * -# 这是...原创 2019-05-16 09:24:53 · 395 阅读 · 0 评论 -
Doxygen注释块的位置
一 一般写法通常注释写在代码前面，例如/** @brief int value a */int a；int b;二 写在代码后面int a； /** @brief int value a */int b;此写法当Doxygen生成文档时其实并不是修饰的a，而是b，如果此时希望能正确修饰a，写法如下：int a； /**< @brief int value...原创 2019-05-15 21:22:58 · 282 阅读 · 0 评论 -
Doxygen注释的几种风格（for C-like languages）
一Javadoc style/** * @brief this is a javadoc style comment1. */ /** @brief this is a javadoc style comment2. *//** @brief this is a javadoc style comment3.*/ class JavaDocStyle{ };J...原创 2019-05-15 21:05:40 · 597 阅读 · 0 评论 -
什么是Doxygen
一 写在前面当你对外的输出为头文件包及库文件时，撰写头文件的说明文档也是不小的工作量：文件、接口、接口参数的注释说明等等。当接口发生变化，不仅要更新注释，还需要更新说明文档，比较繁琐，同时也很容易出错。而Doxygen工具可以帮助从源文件中生成漂亮的html或其他格式的参考文档，只需要你的注释遵循一定的格式规范即可，方便快捷。二 什么是DoxygenGenerate document...原创 2019-05-15 20:44:40 · 903 阅读 · 0 评论 -
Doxygen wizard - Expert - Dot
写在前面Doxygen GUI为Doxygen界面操作工具。本篇为windows版Doxygen1.8.15 配置界面翻译， 翻译不当之处请谅解。本篇包含Doxygen wizard - Expert：Dot部分。DotCLASS_DIAGRAMSIf the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a clas...原创 2019-09-05 20:03:53 · 469 阅读 · 0 评论 -
Doxygen wizard - Expert - AutoGen PerlMod Preprocessor External
写在前面Doxygen GUI为Doxygen界面操作工具。本篇为windows版Doxygen1.8.15 配置界面翻译， 翻译不当之处请谅解。本篇包含Doxygen wizard - Expert： AutoGen + PerlMod + Preprocessor + External部分。AutoGenGENERATE_AUTOGEN_DEFIf the GENERATE_AU...原创 2019-09-05 20:02:57 · 173 阅读 · 0 评论 -
Doxygen wizard - Expert - Man XML Docbook
写在前面Doxygen GUI为Doxygen界面操作工具。本篇为windows版Doxygen1.8.15 配置界面翻译， 翻译不当之处请谅解。本篇包含Doxygen wizard - Expert：Man + XML + Docbook部分。ManGENERATE_MANIf the GENERATE_MAN tag is set to YES, doxygen will gen...原创 2019-09-05 19:59:48 · 243 阅读 · 0 评论 -
Doxygen wizard - Expert - LaTex RTF
写在前面Doxygen GUI为Doxygen界面操作工具。本篇为windows版Doxygen1.8.15 配置界面翻译， 翻译不当之处请谅解。本篇包含Doxygen wizard - Expert：LaTex + RTF部分。LaTexGENERATE_LATEXIf the GENERATE_LATEX tag is set to YES, doxygen will gener...原创 2019-09-05 19:57:32 · 354 阅读 · 0 评论 -
Doxygen wizard - Expert - HTML
写在前面Doxygen GUI为Doxygen界面操作工具。本篇为windows版Doxygen1.8.15 配置界面翻译， 翻译不当之处请谅解。本篇包含Doxygen wizard - Expert：HTML部分。HTMLGENERATE_HTMLIf the GENERATE_HTML tag is set to YES, doxygen will generate HTML o...原创 2019-09-05 19:51:25 · 587 阅读 · 0 评论 -
Doxygen wizard - Expert - Source Browser Index
写在前面Doxygen GUI为Doxygen界面操作工具。本篇为windows版Doxygen1.8.15 配置界面翻译， 翻译不当之处请谅解。本篇包含Doxygen wizard - Expert：Source Browser + Index部分。Source BrowserSOURCE_BROWSERIf the SOURCE_BROWSER tag is set to YES...原创 2019-09-05 19:49:10 · 335 阅读 · 0 评论 -
Doxygen wizard - Expert - Messages Input
写在前面Doxygen GUI为Doxygen界面操作工具。本篇为windows版Doxygen1.8.15 配置界面翻译， 翻译不当之处请谅解。本篇包含Doxygen wizard - Expert：Messages + Input部分。MessagesQUIETThe QUIET tag can be used to turn on/off the messages that ...原创 2019-09-05 19:47:20 · 226 阅读 · 0 评论 -
Doxygen wizard - Expert -Build
写在前面Doxygen GUI为Doxygen界面操作工具。本篇为windows版Doxygen1.8.15 配置界面翻译， 翻译不当之处请谅解。本篇包含Doxygen wizard - Expert：Build部分。BuildEXTRACT_PRIVATEIf the EXTRACT_PRIVATE tag is set to YES, all private members of...原创 2019-09-05 19:44:13 · 350 阅读 · 0 评论 -
Doxygen wizard - Expert - Project
写在前面Doxygen GUI为Doxygen界面操作工具。本篇为windows版Doxygen1.8.15 配置界面翻译， 翻译不当之处请谅解。本篇包含Doxygen wizard - Expert：Project部分。ProjectDOXYFILE_ENCODING 文件编码This tag specifies the encoding used for all character...原创 2019-09-05 19:42:07 · 400 阅读 · 0 评论 -
Doxygen wizard
Doxygen GUI fontend为Doxygen的界面操作工具。本篇为wizard项的界面翻译。step1 :Specify the working directory from which doxygen will run设置doxygen的工作路径step2 :Configure doxygen using the Wizard and/or Expert tab, then...原创 2019-07-01 20:32:15 · 614 阅读 · 0 评论