删除doxygen的\copydoc点？ [英] Remove the dot of doxygen's \copydoc?

问题描述

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

I have a problem with doxygen's \copydoc. Example

file1.h

/*!
 * \file
 * FileOne
 */

file2.h

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

文档始终显示：

这类似于。

This is similar to the.

FileOne。文件。

FileOne. file.

我不希望添加此点（和换行符）。我如何删除它？

I don't want this dot (and newline) added. How can i remove it?

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

The reason is, i want it to read a groupname from that file. If it adds a dot, the group is not found. New Example:

file1.h

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

file2.h

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

文档始终显示：

\。

\ .

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

The file is not added to the group, because it enters FileOne. to the \ingroup command.

推荐答案

这不是 \copydoc 的用途。您试图用它代替文件的名称，但实际上是用 documentation 代替文件（即段落）。

This is not what \copydoc is for. You're trying to use it to substitute a "name" for a file, but what you're actually doing is substituting the documentation for a file, which is a paragraph.

我认为您应该将文件命名为—使用正确的设置， Doxygen将自动生成指向该文件文档的链接

I think you should just name the file — with the correct settings, Doxygen will auto-generate a link to that file's documentation.

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

这篇关于删除doxygen的\copydoc点？的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！