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

Question

在头文件中有一个结构

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

如果没有记录结构的内部元素，doxygen 会生成警告。但是有必要不记录内部元素。那么可以起诉什么。试过\internal 但没有成功

Answer 1

\internal 用于删除部分文档，但在生成内部文档时使用它们。您可能仍想为此条目编写文档。当您想为自己/开发人员生成完整的文档，但为外部世界生成不太详细的文档(或只是省略由于例如 NDA 而无法显示的部分)时，它很有用。

它与其他 doxygen 命令结合使用，例如///\internal\defgroup foo 将仅为内部文档显示整个组(doxygen 配置中的 INTERNAL_DOCS)。您还可以将其用于结构字段:

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

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

您不能定义内部 block ，但可以将\internal 与\defgroup 或\section 结合使用。