【问题标题】:Doxygen displaying documentation within \pageDoxygen 在 \page 中显示文档
【发布时间】:2018-03-14 16:04:46
【问题描述】:

在 C 项目中,我必须将代码记录在专用的 .dox 文件中,而不是 C 文件本身。

.dox 文件的摘录:

/*! \page intro2 Introduction2
Sample text

\fn void foo(void)
@brief foo

foo does nothing.
*/

文档将出现在定义我的函数的 foo.h 文件下的“文件列表”中。我的页面将只显示“示例文本”行。

有没有办法在“示例文本”行之后获取页面本身的文档?

我知道我可以通过小组来实现这一目标。但由于 Doxygen 管理组和页面的方式不同,我更喜欢在 \page 中获取文档。

谢谢,

【问题讨论】:

    标签: doxygen


    【解决方案1】:
    /*! \page intro2 Introduction2
    Sample text
    
    foo
    
    foo does nothing.
    */
    

    .h 对于 foo

    \fn void foo(void)
    @brief foo
    

    不完全是您想要的,但我认为它现在将全部放在一个页面中,您可以单击该链接来阅读有关该功能的链接。如果您真的希望文档出现在页面中,您也可以尝试使用 \copydoc

    【讨论】:

    • 谢谢,但由于我无法更改的选择,我无法在源文件中记录。我真的想要页面中的文档,无法从页面访问。
    猜你喜欢
    • 2016-05-05
    • 1970-01-01
    • 1970-01-01
    • 2020-12-08
    • 2011-06-13
    • 2021-02-04
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    相关资源
    最近更新 更多