Remove the dot of doxygen's \\copydoc?

2019-09-07 11:30发布

问题:

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.
 */

Documentation always says:

This is similar to the.

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
 */

Documentation always says:

\ .

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

回答1:

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.

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.
 */


标签: c++ c doxygen