在一个dox文件中包含多个类的详细信息

时间:2013-07-03 22:45:56

标签: java doxygen

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

/**
 * \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页面)。

有什么想法吗? 感谢

1 个答案:

答案 0 :(得分:0)

你试过\ copydoc吗?

  

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