Doxygen wizard - Expert - Project

写在前面

Doxygen GUI为Doxygen界面操作工具。本篇为windows版Doxygen1.8.15 配置界面翻译, 翻译不当之处请谅解。
本篇包含Doxygen wizard - Expert:Project部分。

Project
  • DOXYFILE_ENCODING 文件编码
    This tag specifies the encoding used for all characters in the configuration file that follow. The default is UTF-8 which is also the encoding used for all text before the first occurrence of this tag. Doxygen uses libiconv (or the iconv built into libc) for the transcoding. See https://www.gnu.org/software/libiconv/ for the list of possible encodings.
    The default value is: UTF-8.
    此标记制定用于后续配置文件中所有字符的编码。默认是UTF-8,同时也用于在此标记首次出现之前所有文本的编码。Doxygen使用libiconv(或内置于libc中的iconv)进行转码,请参阅 https://www.gnu.org/software/libiconv/查看可能的编码列表。默认值为UTF-8。
  • PROJECT_NAME 项目名称
    The PROJECT_NAME tag is a single word (or a sequence of words surrounded by double-quotes, unless you are using Doxywizard) that should identify the project for which the documentation is generated. This name is used in the title of most generated pages and in a few other places.
    The default value is: My Project.
    PROJECT_NAME 是一个单词(或者由双引号包围的单词序列,除非你使用Doxywizard),来标识其生成文档的项目。此名称用于大多数生成页面的标题和其他一些地方。默认值是My Project。
  • PROJECT_NUMBER 项目编号
    The PROJECT_NUMBER tag can be used to enter a project or revision number. This could be handy for archiving the generated documentation or if some version control system is used.
    PROJECT_NUMBER 标记用户进行项目或者修订编号。这对于存档生成文档或使用某些版本控制系统可能很方便。
  • PROJECT_BRIEF 项目简介
    Using the PROJECT_BRIEF tag one can provide an optional one line description for a project that appears at the top of each page and should give viewer a quick idea about the purpose of the project. Keep the description short.
    使用PROJECT_BRIEF 标记可以为项目提供一个可选的一行描述,它出现在每个页面的顶部,并且使查看者快速了解项目的用途。保持描述简短。
  • PROJECT_LOGO 项目图标
    With the PROJECT_LOGO tag one can specify a logo or an icon that is included in the documentation. The maximum height of the logo should not exceed 55 pixels and the maximum width should not exceed 200 pixels. Doxygen will copy the logo to the output directory.
    指定文档包含的徽标或图标,徽标的最大高度不应超过55像素,最大宽度不应超过200像素。Doxygen会将徽标拷贝到输出目录。
  • OUTPUT_DIRECTORY 输出路径
    The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path into which the generated documentation will be written. If a relative path is entered, it will be relative to the location where doxygen was started. If left blank the current directory will be used.
    指定生成文档写入的相对或绝对路径。相对路径相对于doxygen的启动位置,不填写则使用当前路径。
  • CREATE_SUBDIRS 创建子目录
    If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-directories (in 2 levels) under the output directory of each output format and will distribute the generated files over these directories. Enabling this option can be useful when feeding doxygen a huge amount of source files, where putting all generated files in the same directory would otherwise causes performance problems for the file system.
    The default value is: NO.
    如果设置为yes,则doxygen将在每个输出格式的输出目录下创建4096个子目录(分2个级别),并将生成的文件分发到这些目录上。在有大量源文件情况下启动该选项将非常有用,因为将所有生成文件放在同一目录下将导致文件系统的性能问题。默认为no
  • ALLOW_UNICODE_NAMES 允许unicode名称
    If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII characters to appear in the names of generated files. If set to NO, non-ASCII characters will be escaped, for example _xE3_x81_x84 will be used for Unicode U+3044.
    The default value is: NO.
    如果设置为no,doxygen将允许非ASCII字符出现在生成的文件名称中。如果设置为no,非ASCII字符将被转义。默认值为no.
  • OUTPUT_LANGUAGE 输出语言
    The OUTPUT_LANGUAGE tag is used to specify the language in which all documentation generated by doxygen is written. Doxygen will use this information to generate all constant output in the proper language.
    Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, Ukrainian and Vietnamese.
    The default value is: English.
    用于指定输出文件语言,doxygen将使用此信息以适当的预研生成所有常量输出。值包括Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, Ukrainian and Vietnamese.
    默认值为英语
  • OUTPUT_TEXT_DIRECTION 输出文本方向
    The OUTPUT_TEXT_DIRECTION tag is used to specify the direction in which all documentation generated by doxygen is written. Doxygen will use this information to generate all generated output in the proper direction.
    Possible values are: None, LTR, RTL and Context.
    The default value is: None.
  • BRIEF_MEMBER_DESC 成员简洁描述
    If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member descriptions after the members that are listed in the file and class documentation (similar to Javadoc). Set to NO to disable this.
    The default value is: YES.
  • REPEAT_BRIEF 重复简述
    If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief description of a member or function before the detailed description
    Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the brief descriptions will be completely suppressed.
    The default value is: YES.
    如果设置为yes,doxygen会将一个成员或函数的简述放在详细描述之前
    当HIDE_UNDOC_MEMBERS和BRIEF_MEMBER_DESC同时设置为no是,简述将被隐藏。
  • ABBREVIATE_BRIEF 缩写简述
    This tag implements a quasi-intelligent brief description abbreviator that is used to form the text in various listings. Each string in this list, if found as the leading text of the brief description, will be stripped from the text and the result, after processing the whole list, is used as the annotated text. Otherwise, the brief description is used as-is. If left blank, the following values are used (name is automatically replaced with the name of the entity): The name class, The name widget, The name file, is, provides, specifies, contains, represents, a, an and the.

该标记实现一个准智能简述缩写用于在各种列表中的文本,列表中的每个字段串,如果发现是简述的主导文本,将从文本和结果中剥离,在处理所有列表之后,用作带注释的文本。否则,简述将根据需要使用。如果留空,则使用以下值(名称将自动替换为实体名称):名称类,名称组件,名称文件,is, provides, specifies, contains, represents, a, an 和 the.

  • ALWAYS_DETAILED_SEC 总是详述

If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then doxygen will generate a detailed section even if there is only a brief description.

The default value is: NO.

如果该标记 和 REPEAT_BRIEF同时设置为yes,doxygen将生成详细部分,即使只有简述。

  • INLINE_INHERITED_MEMB 内联继承成员

If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited members of a class in the documentation of that class as if those members were ordinary class members. Constructors, destructors and assignment operators of the base classes will not be shown.

The default value is: NO.

如果设置为yes,doxygen将在类文件中显示所有继承成员,就像它们是普通类成员一样,但是基类的构造、析构、赋值运算符不会显示。

  • FULL_PATH_NAMES 全路径名称

If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path before files name in the file list and in the header files. If set to NO the shortest path that makes the file name unique will be used

The default value is: YES.

如果设置为yes,doxygen会在文件列表和头文件中的文件名称前加上全路径。如果设置为no,将会使用使文件名称唯一的最短路径。

  • STRIP_FROM_PATH 剥离路径

The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. Stripping is only done if one of the specified strings matches the left-hand part of the path. The tag can be used to show relative paths in the file list. If left blank the directory from which doxygen is run is used as the path to strip.
Note that you can specify absolute paths here, but also relative paths, which will be relative from the directory where doxygen is started.

This tag requires that the tag FULL_PATH_NAMES is set to YES.

该标记可用于剥离用户定义部分的路径。仅当指定的字符串之一与路径左侧部分匹配时才会进行剥离。标记可用于在文件列表中显示相对路径。如果留空,在doxygen的运行路径会被用作剥离路径。注意你可以在洗出指定绝对路径,也可以指定相对路径,相对于doxygen启动路径。

  • STRIP_FROM_INC_PATH 剥离包含路径

The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the path mentioned in the documentation of a class, which tells the reader which header file to include in order to use a class. If left blank only the name of the header file containing the class definition is used. Otherwise one should specify the list of include paths that are normally passed to the compiler using the -I flag.

该标记可用于剥离类文档中提及的用户定义部分的路径,该部分告诉读者包含哪些头文件可以使用类。如果留空,则仅使用包含类定义的头文件的名称。否则通常通过传递给编译器-I标记来指定包含路径列表。

  • SHORT_NAMES 短名称

If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but less readable) file names. This can be useful is your file systems doesn’t support long names like on DOS, Mac, or CD-ROM.

The default value is: NO.

如果设置为yes,doxygen将生成更短但可读性更差的文件名称。这在DOS Mac 或者CD-ROM等不支持长名称的文件系统中非常有用。

  • JAVADOC_AUTOBRIEF Javadoc样式自动简述

If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the first line (until the first dot) of a Javadoc-style comment as the brief description. If set to NO, the Javadoc-style will behave just like regular Qt-style comments (thus requiring an explicit @brief command for a brief description.)

The default value is: NO.

如果设置为yes,doxygen会在第一行(直至第一个点)的javadoc样式注释解释为简要说明。如果设置为no,javadoc样式将像Qt-style样式注释一样执行(因此需要显示@brief命令进行简要描述)

  • QT_AUTOBRIEF QT样式自动简述

If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first line (until the first dot) of a Qt-style comment as the brief description. If set to NO, the Qt-style will behave just like regular Qt-style comments (thus requiring an explicit \brief command for a brief description.)

The default value is: NO.

如果设置为yes,doxygen会在第一行(直至第一个点)的QT样式注释解释为简要说明。如果设置为no,Qt样式将像常规Qt样式注释一样执行(因此需要显示@brief命令进行简要描述)

  • MULTILINE_CPP_IS_BRIEF 多行CPP简述

The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a multi-line C++ special comment block (i.e. a block of //! or /// comments) as a brief description. This used to be the default behavior. The new default is to treat a multi-line C++ comment block as a detailed description. Set this tag to YES if you prefer the old behavior instead.
Note that setting this tag to YES also means that rational rose comments are not recognized any more.

The default value is: NO.

如果设置为yes,doxygen将把多行C++特殊注释块作为简要描述,这是之前的默认行为。最新默认是将多行C++注释块作为详细描述。如果选择旧的默认行为可将标记设置为yes。注意设置为yes意味着 rational rose 注释不再被识别。

  • INHERIT_DOCS

If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the documentation from any documented member that it re-implements.

The default value is: YES.

如果设置为yes,则未记录的成员将从它重新实现的任何文档成员继承文档。

  • SEPARATE_MEMBER_PAGES 分离成员页

If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new page for each member. If set to NO, the documentation of a member will be part of the file/class/namespace that contains it.

The default value is: NO.

如果设置为yes,doxygen将为每个成员新建页,如果设置为no,成员文档是包含它的文件或类或命名空间的一部分。

  • TAB_SIZE tab大小

The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen uses this value to replace tabs by spaces in code fragments.

Minimum value: 1, maximum value: 16, default value: 4.

  • ALIASES 别名

This tag can be used to specify a number of aliases that act as commands in the documentation. An alias has the form:
name=value
For example adding
“sideeffect=@par Side Effects:\n”
will allow you to put the command \sideeffect (or @sideeffect) in the documentation, which will result in a user-defined paragraph with heading “Side Effects:”. You can put \n 's in the value part of an alias to insert newlines (in the resulting output). You can put ^^ in the value part of an alias to insert a newline as if a physical newline was in the original file.
When you need a literal { or } or , in the value part of an alias you have to escape(转义) them by means of a backslash(反斜线), this can lead to conflicts with the commands { and } for these it is advised to use the version @{ and @} or use a double escape ({ and })

  • TCL_SUBST TCL替换

This tag can be used to specify a number of word-keyword mappings (TCL only). A mapping has the form “name=value”. For example adding “class=itcl::class” will allow you to use the command class in the itcl::class meaning.

  • OPTIMIZE_OUTPUT_FOR_C C语言优化输出

Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources only. Doxygen will then generate output that is more tailored for C. For instance, some of the names that are used will be different. The list of all members will be omitted, etc.

The default value is: NO.

如果你的工程只有C源文件,将该标记设置为yes。doxygen将产生更最对C量身定制的输出。例如一些名称的使用将会不同,成员列表将被省略等。

  • OPTIMIZE_OUTPUT_JAVA JAVA语言优化输出

Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or Python sources only. Doxygen will then generate output that is more tailored for that language. For instance, namespaces will be presented as packages, qualified scopes (限定范围)will look different, etc.

The default value is: NO.

  • OPTIMIZE_FOR_FORTRAN FORTRAN语言优化输出

Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran sources. Doxygen will then generate output that is tailored for Fortran.

The default value is: NO.

  • OPTIMIZE_OUTPUT_VHDL VHDL语言优化输出

Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL sources. Doxygen will then generate output that is tailored for VHDL.

The default value is: NO.

  • OPTIMIZE_OUTPUT_SLICE SLICE语言优化输出

Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice sources only. Doxygen will then generate output that is more tailored for that language. For instance, namespaces will be presented as modules, types will be separated into more groups, etc.

The default value is: NO.

  • EXTENSION_MAPPING 扩展映射

Doxygen selects the parser to use depending on the extension of the files it parses. With this tag you can assign which parser to use for a given extension. Doxygen has a built-in mapping, but you can override or extend it using this tag. The format is ext=language, where ext is a file extension, and language is one of the parsers supported by doxygen: IDL, Java, Javascript, Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice, Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: Fortran. In the later case the parser tries to guess whether the code is fixed or free formatted code, this is the default for Fortran type files), VHDL, tcl. For instance to make doxygen treat .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran), use: inc=Fortran f=C.
Note: For files without extension you can use no_extension as a placeholder.
Note that for custom extensions you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.

doxygen根据解析的问题的扩展名选择要使用的解析器。使用此标记,你可以分配用于特定扩展的解析器。doxygen有内置映射,但是你可以通过此标记重写或者扩展它。格式是ext=language, 其中ext是文件扩展名,language是doxygen支持的解析器之一:IDL, Java, Javascript, Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice, Fortran, VHDL, tcl。例如,使doxygen将.inc文件作为Fortran文件,并且将.f文件作为C文件,使用inc=Fortran f=C。注意对于没有扩展的文件,可以使用no_extension作为占位符。注意对于自定义扩展,你还需要设置FILE_PATTERNS,否则文件不会被doxygen读取。

  • MARKDOWN_SUPPORT MD支持

If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments according to the Markdown format, which allows for more readable documentation. See https://daringfireball.net/projects/markdown/ for details. The output of markdown processing is further processed by doxygen, so you can mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in case of backward compatibilities issues.

The default value is: YES.

如果启动了MARKDOWN_SUPPORT标记,则doxygen根据md格式预处理所有注释,从而允许更可读的文档。请参考 https://daringfireball.net/projects/markdown/ 。md处理的输出由doxygen进一步处理,所以你可以将doxygen\html、xml命令与md格式进行混合。仅在出现向后兼容性问题时禁用。

  • TOC_INCLUDE_HEADINGS

When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up to that level are automatically included in the table of contents, even if they do not have an id attribute.
Note: This feature currently applies only to Markdown headings.

Minimum value: 0, maximum value: 99, default value: 0.

This tag requires that the tag MARKDOWN_SUPPORT is set to YES.

当TOC_INCLUDE_HEADINGS标记设置为非零值时,该界别的所有标题都将自动包含在目录中,即使他们没有id属性。注意该功能目前仅适用于md标题。

  • AUTOLINK_SUPPORT

When enabled doxygen tries to link words that correspond to documented classes, or namespaces to their corresponding documentation. Such a link can be prevented in individual cases by putting a % sign in front of the word or globally by setting AUTOLINK_SUPPORT to NO.

The default value is: YES.

当启动doxygen尝试将对应于文档类或者命名空间的单词链接到相应文档时。在个别情况下通过将AUTOLINK全局设置为no,或者在单词前面放置%符号,来阻止此类链接。

  • BUILTIN_STL_SUPPORT

If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to include (a tag file for) the STL sources as input, then you should set this tag to YES in order to let doxygen match functions declarations and definitions whose arguments contain STL classes (e.g. func(std::string); versus func(std::string) {}). This also make the inheritance and collaboration diagrams that involve STL classes more complete and accurate.

The default value is: NO.

如果使用std类,例如std::string 、std::vector等,但是不想包含std源文件作为输入,则应将该标记设置为yes以便让doxygen匹配参数中包含stl(例如func(std::string),与 func(std::string) {}))的函数申明和定义。这还使涉及stl类的继承和协作关系图更完整和准确。

  • CPP_CLI_SUPPORT

If you use Microsoft’s C++/CLI language, you should set this option to YES to enable parsing support.

The default value is: NO.

如果你使用微软的C++/CLI语言,应该将该选项设置为yes以获得解析支持。

  • SIP_SUPPORT

Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. Doxygen will parse them like normal C++ but will assume all classes use public instead of private inheritance when no explicit protection keyword is present.

将该标记设置为yes如果你的项目仅包含sip源文件。doxygen会像正常C++一样解析它们,但是会设置所有类使用public继承取代private继承如果没有显示申明保护关系字。

The default value is: NO.

  • IDL_PROPERTY_SUPPORT

For Microsoft’s IDL there are propget and propput attributes to indicate getter and setter methods for a property. Setting this option to YES will make doxygen to replace the get and set methods by a property in the documentation. This will only work if the methods are indeed getting or setting a simple type. If this is not the case, or you want to show the methods anyway, you should set this option to NO.

The default value is: YES.

对于微软的IDL有propget和propput属性来表明一个属性的getter和setter方法。将此选项设置为yes使doxygen通过文档中的属性替换get和set方法。仅当方法getting或setting一个简单类型时有效。如果不是这样或者你仍要显示方式,则应将该选项设置为no.

  • DISTRIBUTE_GROUP_DOC

If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC tag is set to YES then doxygen will reuse the documentation of the first member in the group (if any) for the other members of the group. By default all members of a group must be documented explicitly.

The default value is: NO.

如果在文档中使用了成员分组,并且 DISTRIBUTE_GROUP_DOC 标记设置为yes,doxygen将重用组中第一个成员的文档。默认必须显示记录组的所有成员。

  • GROUP_NESTED_COMPOUNDS

If one adds a struct or class to a group and this option is enabled, then also any nested class or struct is added to the same group. By default this option is disabled and one has to add nested compounds explicitly via \ingroup .

The default value is: NO.

如果将结果或者类添加到组,并且启动了该选项,则还会将任何嵌套类或者结果增加到同一组,默认该选项被禁用,并且必须通过\ingroup显式添加嵌套结构。

  • SUBGROUPING

Set the SUBGROUPING tag to YES to allow class member groups of the same type (for instance a group of public functions) to be put as a subgroup of that type (e.g. under the Public Functions section). Set it to NO to prevent subgrouping. Alternatively, this can be done per class using the \nosubgrouping command.

The default value is: YES.

将该标记设置为yes,以允许将相同类型的类成员组(例如一组公共函数)作为该类型的子组(例如在公共函数部分下)。将其设置为no,以防止分组。或者可以通过对每个分组使用\nosubgrouping命令。

  • INLINE_GROUPED_CLASSES

When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions are shown inside the group in which they are included (e.g. using \ingroup ) instead of on a separate page (for HTML and Man pages) or section (for LaTeX and RTF).
Note that this feature does not work in combination with SEPARATE_MEMBER_PAGES .

The default value is: NO.

如果该标记设置为yes,类、结构和联合体将在包含它们的组中显示(譬如使用\ingroup)而不是显示在单独的页面(对于HTML和帮助文档)或者节(对于LaTeX和RTF).注意此功能不与SEPARATE_MEMBER_PAGES结合使用。

  • INLINE_SIMPLE_STRUCTS

When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions with only public data fields or simple typedef fields will be shown inline in the documentation of the scope in which they are defined (i.e. file, namespace, or group documentation), provided this scope is documented. If set to NO, structs, classes, and unions are shown on a separate page (for HTML and Man pages) or section (for LaTeX and RTF).

The default value is: NO.

当该标记设置为yes,仅具有公共数据字段或者简单typedef字段的结果、类和联合体将在定义它们的范围的文档中内联显示(例如文件、命名空间或组文档),前提是记录此作用域。如果设置为no,结构、类和联合体将显示在单独的页面上。(对于HTML和帮助文档)或者节(对于LaTeX和RTF)

  • TYPEDEF_HIDES_STRUCT

When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or enum is documented as struct, union, or enum with the name of the typedef. So typedef struct TypeS {} TypeT, will appear in the documentation as a struct with name TypeT. When disabled the typedef will appear as a member of a file, namespace, or class. And the struct will be named TypeS. This can typically be useful for C code in case the coding convention dictates that all compound types are typedef’ed and only the typedef is referenced, never the tag name.

The default value is: NO.

启用 TYPEDEF_HIDES_STRUCT 标记后,结构、联合或枚举的类型定义将记录为结构、联合或枚举,并带有类型def的名称。因此,typedef struct TypeS {} TypeT,将作为名称 TypeT 的结构显示在文档中。禁用时,typedef 将显示为文件、命名空间或类的成员。结构将命名为 TypeS。这在编码约定规定所有复合类型都是 typedef’ed 且仅typedef被引用 而不是标记名称时对 C 代码非常有用。

  • LOOKUP_CACHE_SIZE

The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given their name and scope. Since this can be an expensive process and often the same symbol appears multiple times in the code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small doxygen will become slower. If the cache is too large, memory is wasted. The cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0…9, the default is 0, corresponding to a cache size of 2^16=65536 symbols. At the end of a run doxygen will report the cache usage and suggest the optimal cache size from a speed point of view.

Minimum value: 0, maximum value: 9, default value: 0.

可以设置为LOOKUP_CACHE_SIZE。该缓存可以用于解析给定名称和范围的符号。由于这可能是一个昂贵的过程并且代码中经常出现多次相同的符号,所以doxygen保留了一个缓存的预先解析的符号。如果缓存太小,doxygen会变慢,如果缓存太大,内存会浪费。缓存大小由公式给出: 2^(16+LOOKUP_CACHE_SIZE)。有效范围是0…9,默认是0,对应于 2^16=65536符号的缓存大小。在运行结束时将报告缓存使用情况并从速度的角度建议最佳缓存大小。

  • 0
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值