删除doxygen的\ copydoc点?

时间:2015-03-16 09:42:06

标签: c++ c doxygen

我遇到了doxygen' \copydoc的问题。实施例

file1.h

/*!
 * \file
 * FileOne
 */

file2.h

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

文档总是说:

  

这类似于。

     

FileOne。文件。

我不想要添加此点(和换行符)。我该如何删除它?

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

file1.h

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

file2.h

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

文档总是说:

  

\。

该文件未添加到组中,因为它会将FileOne.输入\ingroup命令。

1 个答案:

答案 0 :(得分:0)

这不是\copydoc的用途。您正试图用它来代替"名称"对于一个文件,但你实际做的是用文档替换一个文件,这是一个段落。

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

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