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

【问题标题】：Include details from multiple classes in one dox file在一个 dox 文件中包含来自多个类的详细信息
【发布时间】：2013-07-01 19:25:46
【问题描述】：

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

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

但它似乎不起作用。

有人知道吗？

谢谢计算机科学

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

我也尝试了另一种方法，在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 页面）。

有什么想法吗？谢谢

【问题讨论】：

标签： java doxygen

【解决方案1】：

您尝试过 \copydoc 吗？

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

【讨论】：

您需要提供更多信息。你得到了什么？你真正期望的是什么？同时发布你的 doxygen 文件。你有主页吗？我能够获得我认为您正在寻找的那种文档。
哦，我的想法是，我将把文档放在每个 .java 文件中，并且我将有一个主要的 dox 文件，它将所有这些文档分组并列出。例如，在 class1.java 中，我将有“/** Doc for Class1 ...”，在 class2.java 中，我将有“/** Doc for Class2 ...”。然后在 main.dox 中，我想引用 Class1 和 Class2 中的那些文档，以便在生成的页面中，它将具有“Class1 的文档 .... Class2 的文档 ...”。
我已更新原始问题以包含 main.dox 和 class1.java。谢谢
当您执行@copydoc group1 时，它将复制@addtogroup group1 块下的文档，而不是group1 下的整个文档。如果您执行@copydoc Class1，它将复制 Class1 的文档，但不会引用 Class1。在主页尝试@ref Class1 @copydoc Class1等。