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

Question

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

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

有什么想法吗？谢谢

Answer 1

你尝试过\copydoc吗？

Copies a documentation block from the object specified by and pastes it at the location of the command. This command can be useful to avoid cases where a documentation block would otherwise have to be duplicated or it can be used to extend the documentation of an inherited member.