1

我有一组执行一些日期计算的类。在每个类中,我记录了一些关于该类的一般信息及其示例用法,例如:

/**
 * \brief Get the number of release date for a given year
 * 
 * \b Example:
 * 
 * \code
 *   GetReleaseDateCount col = new GetReleaseDateCount(1990);
 *   col.calculate();
 * \endcode
 */
public class GetReleaseDateCount

那么是否可以从不同的类中复制所有这些细节并将它们作为单个 dox 文件中内容的一部分?我试图将以下内容放入 dox 文件中:

\copydetails GetReleaseDateCount

但它似乎不起作用。

有人有什么想法吗?

谢谢 CS

- - - - - - - - - - - - - - - 更新 - - - - - - - - - - ------------------

我还尝试了另一种方法,在 class1.java 中,我添加了:

/** @addtogroup group1
 *  @{
 */

/**
 * @details
 *
 * Class1 Details
 */

/** @} */
public class Class1

然后在 main.dox 中,我有:

/*!
   \page page1 Page1

   \tableofcontents  

   \section Classes Information

   \copydoc group1

 */

这样做,main.dox 上不会显示任何内容。内容仅显示在 Class1 的详细信息上。

但是,如果我将 Class1.java 更改为:

/** @addtogroup group1
 * 
 * @details
 *
 * Class1 Details
 */

那么 main.dox 将包含 Class1 的详细信息,但 Class1 的详细信息将为空白(Class1 的 html 页面)。

任何想法?谢谢

4

1 回答 1

0

你试过\copydoc吗?

从 指定的对象复制文档块并将其粘贴到命令的位置。此命令可用于避免文档块必须复制或可用于扩展继承成员的文档的情况。

于 2013-07-05T07:12:26.083 回答