在doxygen中使用\ internal来隐藏结构的内部元素

Question

在头文件中有一个结构

/* temp example structure*/
typedef struct {
        /* @internal */
        char *c;
        /* @internal */
        char *ts;
} j;

如果未记录结构的内部元素，则doxygen会生成警告。 但有必要不记录内部要素。 那么什么可以被起诉。 尝试\内部但它没有工作

Answer 1

\internal用于删除部分文档，但在生成内部文档时使用它们。您可能仍希望为此条目编写文档。当您想为自己/开发人员生成完整的文档时，它会很有用，但是对于外部世界，会生成较少的详细信息（或者只是省略了因NDA而无法显示的部分）。

它与其他doxygen命令结合使用，例如/// \internal \defgroup foo将仅针对内部doc（doxygen config中的INTERNAL_DOCS）显示整个组。您也可以将它用于结构字段：

struct foo {
   int field0;    /**< Documented field */
   int field1;    /**< \internal only documented for internal doc */
};

字段在结构文档中仍然可见，但第二个字段将遗漏任何文档。

您无法定义内部阻止，但可以将\internal与\defgroup或\section合并。