【问题标题】:Remove the dot of doxygen's \copydoc?删除 doxygen 的 \copydoc 的点?
【发布时间】:2015-03-16 09:42:06
【问题描述】:

我对 doxygen 的 \copydoc 有疑问。示例

file1.h

/*!
 * \file
 * FileOne
 */

file2.h

/*!
 * \file
 * This is similar to the \copydoc file1.h file.
 */

文档总是说:

这类似于。

文件一。文件。

我不想添加这个点(和换行符)。怎么去掉?

原因是,我希望它从该文件中读取组名。如果它添加一个点,则找不到该组。新示例:

file1.h

/*!
 * \defgroup FileOne
 */
/*!
 * \file
 * FileOne
 */

file2.h

/*!
 * \file
 * \ingroup \copydoc file1.h
 */

文档总是说:

\.

文件未添加到组中,因为它在\ingroup 命令中输入了FileOne.

【问题讨论】:

    标签: c++ c doxygen


    【解决方案1】:

    这不是\copydoc 的用途。您试图用它来代替文件的“名称”,但实际上您正在做的是用 documentation 代替文件,这是一个段落。

    我认为您应该只命名文件 - 使用正确的设置,Doxygen will auto-generate a link to that file's documentation

    /*!
     * \file
     * This is similar to the file1.h file.
     */
    

    【讨论】:

    • 我知道,我正在使用\copydoc 来处理它不适合的情况。有关问题,请参见我的第二个示例。
    • @kuga 是的,你仍在尝试做一些不应该做的事情。文档段落是不可替代的变量。写\ingroup FileOne
    • 嗯,有没有办法用 doxgen 变量来做到这一点。就像在 file1.h 中定义名称并在 file2.h 中使用它一样?我不认为有变量,有吗?
    • @kuga 不,我不这么认为,你的要求对我来说似乎很奇怪。为什么要说“此文件与其他文件在同一组中”而不是“此文件在 G 组中”?
    • 我为此设置了follow up question
    猜你喜欢
    • 2011-06-27
    • 2013-06-29
    • 2013-08-02
    • 2015-06-19
    • 1970-01-01
    • 1970-01-01
    • 2015-03-05
    • 2015-03-06
    • 1970-01-01
    相关资源
    最近更新 更多