Doxygen使用学习(五)------Doxygen的特殊命令字之"创建连接命令"

    xiaoxiao2026-04-23  9

    创建连接命令

    @addindex (text)

    添加1文本到latex索引中

    @anchor

    放置一个不可见的已命名的anchor(固定点)到文档中,且能使用@ref命令进行引用。 注意:anchor目前只能放置在一个标记成页面(使用@page)或主页(使用@mainpage)的注释块中

    @cite

    增加一个书籍参考到一个文本和数目参考列表里。

    @endlink

    终止一个命令@link开始的连接

    @link

    连接是由doxygen自动生成的,且一直有一个指向的对象名作为连接文本。该命令可以用于创建一个对象(一个文件,类或者成员)的连接,并且用户可指定对象的连接文本。此命令可以被@endlink终止,所有在其之间的文本都将作为指向@link第一个参数<link-object>的连接文本。

    @ref [“(text)”]

    创建一个已命名小节,子小节,页面或anchor(固定点)的引用,在HTML文档中该命令将生成一个指向小节的连接。在一个小节或者子小节中将使用小节标题作为连接文本,在anchor(固定点)中可使用引号间的text或者当text忽略时使用<name>作为连接文本,而在latex文档中,如果<name>引用的是一个anchor(固定点),该命令将小节生成一个编号或者是使用一个页面编号后的文本。

    @refitem

    就像@ref命令,这个命令创建一个名字小节的引用,但是这个在一个以@secreflist开始,@endsecreflist结束的列表中。

    @secreflist

    开始一个标题列表,用@refitem创建,每一个都连接到对应的名字小节

    @endsecreflist

    开始以@secreflist开头的标题列表。

    @subpage [“(text)”]

    创建若干页面的一个层次,相同结构也可以使用@defgroup,@ingroup命令,但在页面中使用@subpage命令更方便。主页@mainpage通常是层次的根节点。

    该命令类似于@ref,它用于创建一个到<name>页面标签的引用,并且可选择第二个参数指定的text作为连接文本。

    它不同于@ref命令之处在于,它只能工作在页面中,在页面中创建一个父子关联,并且子页面使用<name>进行标识。

    例如:

    /*! @mainpage A simple manual Some general info. This manual is divided in the following sections: - @subpage intro - @subpage advanced "Advanced usage" */ //----------------------------------------------------------- /*! @page intro Introduction This page introduces the user to the topic. Now you can proceed to the @ref advanced "advanced section". */ //----------------------------------------------------------- /*! @page advanced Advanced Usage This page is for advanced users. Make sure you have first read @ref intro "the introduction". */ @tableofcontents

    在页面顶端创建一个内容表格,列出页面中所有小节和子小节

    警告:该命令只能工作在一个相关页文档块的小节中,而无法工作于其他文档块中而且仅仅在HTML输出中有效。

    @section (section title)

    创建一个名为<section-name>的小节,小节的标题可使用命令的第二参数指定。

    警告:该命令只能工作在一个相关页文档块的小节中,而无法工作于其他文档块中。

    @subsection (subsection title)

    创建一个名为<section-name>的子小节,小节的标题可使用命令的第二参数指定。

    警告:该命令只能工作在一个相关页文档块的小节中,而无法工作于其他文档块中。

    @subsubsection (subsubsection title)

    创建一个名为<section-name>的子小节的小节,小节的标题可使用命令的第二参数指定。

    警告:该命令只能工作在一个相关页文档块的小节中,而无法工作于其他文档块中。

    @paragraph (paragraph title)

    创建一个名为<paragraph-name>的段落,它的标题可使用命令的第二参数指定。

    警告:该命令只能工作在一个相关页文档块的小节中,而无法工作于其他文档块中。

    转载请注明原文地址: https://ju.6miu.com/read-1309130.html
    最新回复(0)