Fatal编程技术网
  • doxygen/
  • 在doxygen中使用\internal隐藏结构的内部元素

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

doxygen

在doxygen中使用\internal隐藏结构的内部元素,doxygen,Doxygen,在头文件中有一个结构 /* temp example structure*/ typedef struct { /* @internal */ char *c; /* @internal */ char *ts; } j; 如果未记录结构的内部元素，doxygen将生成警告。 但有必要不记录内部要素。 那么什么可以被起诉呢。 已尝试\internal但无效\internal用于删除部分文档，但在生成内部文档时使用它们。您可能仍然希

在头文件中有一个结构

/* temp example structure*/
typedef struct {
        /* @internal */
        char *c;
        /* @internal */
        char *ts;
} j;
如果未记录结构的内部元素，doxygen将生成警告。 但有必要不记录内部要素。 那么什么可以被起诉呢。
已尝试\internal但无效

\internal
用于删除部分文档，但在生成内部文档时使用它们。您可能仍然希望为此条目编写文档。当您希望为自己/开发人员生成完整文档，但为外部世界生成不太详细的部分（或仅省略因NDA等原因而无法显示的部分）时，此功能非常有用

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

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

structfoo{
int field0；/**
字段仍将在结构文档中可见，但第二个字段将丢失任何文档

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