c - Doxygen for C——多个对象

Question

所以，我正在学习如何使用 Doyxgen 创建文档。我几乎已经完成了单个文件文档，即如何指定参数、放置方程式、指定输出等。

我不确定如何在不让生成的 pdf 复制文档的情况下跨多个对象记录多个文件。例如，在我的主文件中，我有：

extern double getPMF(.....);

我宁愿不将其记录为主要函数，而是作为我的数学对象中的函数。我现在这样做的方式是，该函数的文档显示在我的主文件 c 和我的数学 c 文件的描述中。

我该怎么做呢？

修复：为了澄清，这个函数在我生成的所有文件参考文档中都有重复。我只想将此函数记录在我的 maths.c 文件参考中，但它会被添加到头文件参考中，以及现在需要调用它的任何文件中。

Answer 1

一种快速的解决方案是标记您希望 Doxygen 忽略的元素：

/** \cond doxy_ignore */
double getPMF();

/** \endcond */

听起来被忽略的部分可能涵盖了您的某些文件的大部分。