This is a document generation tool, you can generate a document by the comments in the code file, you can draw calls by drawing tools and processes files containing relations.
Then in the course, you may find no documentation generation member variables.
This is because doxygen not exported to private members, you can press the following configuration.
doxygen configuration options meaning Detailed
| Options | meaning |
|---|---|
| DOXYFILE_ENCODING | Doxygen file encoding, default is UTF-8, if you want to support Chinese, it is best to GB2312 |
| PROJECT_NAME | Project name to a word-based, multiple words, use double quotes. |
| PROJECT_VERSION | Project's version number. |
| OUTPUT_DIRECTORY | Output path. The resulting file will be placed under this path. If you do not fill in this path, the path will be located as an output current path. |
| OUTPUT_LANGUAGE | Output language, the default is English. |
| EXTRACT_ALL | Is NO, there is only explained doxygen annotated code format; is YES, parsing all code, even if no comment |
| EXTRACT_PRIVATE | Private members resolve to class |
| EXTRACT_STATIC | Resolve to static entry |
| EXTRACT_LOCAL_CLASSES | Whether to resolve the class source file (file CPP) defined |
| INPUT | Specify the load or find the program code to process the file path. Here is a table column type patterns. And you can specify the path and file. |
| FILE_PATTERNS | If your INPUT Tag in the specified directory. You can use this Tag to ask when dealing with Doxygen only operate for a specific file. For example: You want to expand on the directory named .c, .cpp and .h files for processing. You can set = FILE_PATTERNS .c, .cpp, * .h. |
| RECURSIVE | This is a Boolean value of Tag, accepts only YES or NO. When set to YES, all subdirectories INPUT the specified directory will be processed. |
| EXCLUDE | If you have a few specific files or directories, you do not want to go through Doxygen processing. You can specify this in Tag. |
| EXCLUDE_PATTERNS | FILE_PATTERNS similar usage, but this is for EXCLUDE Tag used. |
| SOURCE_BROWSER | If set to YES, Doxygen will generate a list of source files for inspection. |
| INLINE_SOURCES | If set to YES, the function and implementation of the class code is contained in the document |
| ALPHABETICAL_INDEX | If set to YES, then in accordance with a alphabetical list will be added in the resulting file. (There are a lot of classes, structures other items recommended when set to YES) |
| GENERATE_HTML | If set to YES, it will generate HTML version of the documentation. HTML file format is one of the preset Doxygen generated. |
| HTML_OUTPUT | HTML file output directory. This is a relative path, so the actual path OUTPUT_DIRECTORY plus HTML_OUTPUT. This setting defaults to html. |
| GENERATE_HTMLHELP | Whether to generate compressed HTML format document (.chm) |
| HTML_FILE_EXTENSION | HTML file name extension. Default is .html. |
| HTML_HEADER | To use Header on each page HTML file. If not specified, Doxygen will use its own default Header. |
| HTML_FOOTER | To use the Footer on each page HTML file. If not specified, Doxygen will use its own default Footer. |
| HTML_STYLESHEET | You may be given a set of CSS, HTML output so that more perfect. |
| GENERATE_HTMLHELP | As is set to YES, Doxygen will generate an index file. The index file in HTML format when you need to make the windows on the HELP file will be used on. |
| GENERATE_TREEVIEW | If set to YES, Doxygen will help you generate a tree structure in the left side of the screen. The tree is being written in JavaScript. The new version of Browser is required to display correctly. |
| TREEVIEW_WIDTH | Used to set the width of the tree structure on the screen. |
| GENERATE_LATEX | When set to YES, it produces LaTeX files. However, your system must have the tools to install the LaTeX. |
| LATEX_OUTPUT | LaTeX文件的输出目录，与HTML_OUTPUT用法相同，一样是指在OUTPUT_DIRECTORY之下的路径。预设为latex。 |
| LATEX_CMD_NAME | LaTeX程序的命令名称及档案所在。预设为latex。 |
| GENERATE_RTF | 若设定为YES ，则会产生RTF 格式的说明档。 |
| RTF_OUTPUT | 与HTML_OUTPUT 用法相同，用来指定RTF 输出档案路径。预设为rtf。 |
| GENERATE_MAN | 若设定为YES ，则会产生Unix Man Page 格式的说明文件。 |
| MAN_OUTPUT | 与HTML_OUTPUT 用法相同，用来指定Man Page的输出目录。预设为man。 |
| GENERATE_XML | 若设定为YES ，则会产生XML 格式的说明文件。 |
| ENABLE_PREPROCESSING | 若设定为YES ，则Doxygen 会激活C 的前置处理器来处理原始档。 |
| PREDEFINED | 可以让您自行定义一些宏。类似于gcc 中的-D选项。 |
| CLASS_DIAGRAMS | 这个标记用来生成类继承层次结构图。要想生成更好的视图，可以从 Graphviz 下载站点 下载 dot 工具。Doxyfile 中的以下标记用来生成图表： |
| HAVE_DOT | 如果这个标记设置为 Yes，doxygen 就使用 dot 工具生成更强大的图形，比如帮助理解类成员及其数据结构的协作图。注意，如果这个标记设置为 Yes， 标记就无效了 |
| CLASS_GRAPH | 如果 标记和这个标记同时设置为 Yes，就使用 dot 生成继承层次结构图 |
| GRAPHICAL_HIERARCHY | 设置为YES时，将会绘制一个图形表示的类图结构 |
