ICode9

精准搜索请尝试: 精确搜索
首页 > 其他分享> 文章详细

Doxygen wizard - Expert - Man XML Docbook

2019-09-05 21:00:50  阅读:277  来源: 互联网

标签:XML Doxygen Expert tag YES man GENERATE MAN


写在前面

Doxygen GUI为Doxygen界面操作工具。本篇为windows版Doxygen1.8.15 配置界面翻译, 翻译不当之处请谅解。
本篇包含Doxygen wizard - Expert:Man + XML + Docbook部分。

Man
  • GENERATE_MAN

If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for classes and files.

The default value is: NO.

man输出

  • MAN_OUTPUT

The MAN_OUTPUT tag is used to specify where the man pages will be put. If a relative path is entered the value of OUTPUT_DIRECTORY will be put in front of it. A directory man3 will be created inside the directory specified by MAN_OUTPUT.

The default directory is: man.

This tag requires that the tag GENERATE_MAN is set to YES.

MAN_OUTPUT标记用于指定将在何处放置手册页。如果输入了相对路径,输出目录的值将放在它前面。man3目录将在MAN_OUTPUT指定的目录中创建。

  • MAN_EXTENSION

The MAN_EXTENSION tag determines the extension that is added to the generated man pages. In case the manual section does not start with a number, the number 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is optional.

The default value is: .3.

This tag requires that the tag GENERATE_MAN is set to YES.

MAN_EXTENSION标记确定添加到生成的手册页的扩展名。如果手册部分不是以数字开头,则数字3是预先准备好的。MAN_EXTENSION标记开头的点(.)是可选的。

  • MAN_SUBDIR

The MAN_SUBDIR tag determines the name of the directory created within MAN_OUTPUT in which the man pages are placed. If defaults to man followed by MAN_EXTENSION with the initial . removed.

This tag requires that the tag GENERATE_MAN is set to YES.

MAN_SUBDIR标记确定在MAN_OUTPUT中创建的目录名,其中放置了man pages。如果默认为man,则在MAN_EXTENSION后加上初始值。移除的。

  • MAN_LINKS

If the MAN_LINKS tag is set to YES and doxygen generates man output, then it will generate one additional man file for each entity documented in the real man page(s). These additional files only source the real man page, but without them the man command would be unable to find the correct page.

The default value is: NO.

This tag requires that the tag GENERATE_MAN is set to YES.

如果MAN_LINKS标记设置为yes,并且doxygen生成man输出,那么它将为实际手册页中记录的每个实体生成一个额外的man文件。这些额外的文件只来源于真正的手册页,但是如果没有它们,man命令将无法找到正确的页面。

XML
  • GENERATE_XML

If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that captures the structure of the code including all documentation.

The default value is: NO.

如果GENERATE_XML标记设置为yes,那么doxygen将生成一个XML文件,该文件捕获包括所有文档在内的代码结构。

  • XML_OUTPUT

The XML_OUTPUT tag is used to specify where the XML pages will be put. If a relative path is entered the value of OUTPUT_DIRECTORY will be put in front of it.

The default directory is: xml.

This tag requires that the tag GENERATE_XML is set to YES.

XML_OUTPUT标记用于指定XML页的放置位置。如果输入了相对路径,输出目录的值将放在它前面。
默认目录是:xml。

  • XML_PROGRAMLISTING

If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program listings (including syntax highlighting and cross-referencing information) to the XML output. Note that enabling this will significantly increase the size of the XML output.

The default value is: YES.

This tag requires that the tag GENERATE_XML is set to YES.

如果XML_PROGRAMLISTING标记设置为yes,那么doxygen将把程序列表(包括语法突出显示和交叉引用信息)转储到xml输出。请注意,启用此选项将显著增加XML输出的大小。

  • XML_NS_MEMB_FILE_SCOPE

If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, doxygen will include namespace members in file scope as well, matching the HTML output.

The default value is: NO.

This tag requires that the tag GENERATE_XML is set to YES.

如果XML_NS_MEMB_FILE_SCOPE标记设置为yes,那么doxygen也将在文件范围中包含与HTML输出匹配的命名空间成员。

Docbook
  • GENERATE_DOCBOOK

If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files that can be used to generate PDF.

The default value is: NO.

如果GENERATE_DOCBOOK标记设置为Yes,则Doxygen将生成可用于生成PDF的DocBook文件。

  • DOCBOOK_OUTPUT

The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put. If a relative path is entered the value of OUTPUT_DIRECTORY will be put in front of it.

The default directory is: docbook.

This tag requires that the tag GENERATE_DOCBOOK is set to YES.

DOCBOOK_OUTPUT 标记用于指定DocBook页面的放置位置。如果输入了相对路径,输出目录的值将放在它前面。
默认目录为:docbook。

  • DOCBOOK_PROGRAMLISTING

If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the program listings (including syntax highlighting and cross-referencing information) to the DOCBOOK output. Note that enabling this will significantly increase the size of the DOCBOOK output.

The default value is: NO.

This tag requires that the tag GENERATE_DOCBOOK is set to YES.

如果 DOCBOOK_PROGRAMLISTING标记设置为yes,那么doxygen将把程序列表(包括语法突出显示和交叉引用信息)包括到docbook输出中。请注意,启用此选项将显著增加docbook输出的大小。

标签:XML,Doxygen,Expert,tag,YES,man,GENERATE,MAN
来源: https://blog.csdn.net/luoshabugui/article/details/100565884

本站声明: 1. iCode9 技术分享网(下文简称本站)提供的所有内容,仅供技术学习、探讨和分享;
2. 关于本站的所有留言、评论、转载及引用,纯属内容发起人的个人观点,与本站观点和立场无关;
3. 关于本站的所有言论和文字,纯属内容发起人的个人观点,与本站观点和立场无关;
4. 本站文章均是网友提供,不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属;如您发现该文章侵犯了您的权益,可联系我们第一时间进行删除;
5. 本站为非盈利性的个人网站,所有内容不会用来进行牟利,也不会利用任何形式的广告来间接获益,纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。

专注分享技术,共同学习,共同进步。侵权联系[81616952@qq.com]

Copyright (C)ICode9.com, All Rights Reserved.

ICode9版权所有