【问题标题】:Doxygen: how to create documentation a chapter (for pdf) and how it would look in html?Doxygen:如何创建文档一章(用于 pdf)以及它在 html 中的外观?
【发布时间】:2012-04-08 10:27:49
【问题描述】:

所以我有这个little project of mine,我做了它,以便我的一些服务器自动生成PDF 形式和HTML 的doxygen 文档。当我查看 pdf 时,我看到:

当我查看 HTML 时,我看到了:

这意味着我用/*! @mainpage CF Cloud Observer Server ... 之类的东西定义了here 的主页已创建。

我想知道如何创建一个在主文档页面(CF Cloud Observer Server 章节)之后开始并且不会成为其中一部分的章节(比如在 CF Cloud Observer Server chapter 之后 Module Documentation 之前名为 CF CO Tutorials 的教程)?

【问题讨论】:

    标签: c++ documentation doxygen documentation-generation


    【解决方案1】:

    您可以使用\page 命令创建任意数量的附加页面。例如:

    /**
     * \page tutorials CF CO Tutorials
     * A page containing Tutorial information.
     */
    

    如果您确实想为某个部分创建子页面,您也可以这样做。在这种情况下,您可以使用\subpage 命令指定父页面中的子页面,例如:

    /**
     * \page tutorials CF CO Tutorials
     * A page containing Tutorial information.
     *
     * \subpage tutorial1
     */
    
    /**
     * \page tutorial1 Tutorial 1
     * A subpage covering Tutorial 1
     */
    

    在这种情况下,Tutorial 1 现在将显示为CF CO Tutorials 的子页面。

    您可以找到有关\page\subpage 命令以及相关\section\subsection 命令here 的更多信息。

    【讨论】:

      猜你喜欢
      • 1970-01-01
      • 2013-04-09
      • 2011-12-02
      • 2011-11-18
      • 2011-06-13
      • 2016-12-06
      • 1970-01-01
      • 2014-09-09
      • 2016-01-25
      相关资源
      最近更新 更多