diff options
Diffstat (limited to 'doc/config.doc')
| -rw-r--r-- | doc/config.doc | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/doc/config.doc b/doc/config.doc index cd69fc6..029583a 100644 --- a/doc/config.doc +++ b/doc/config.doc @@ -214,6 +214,7 @@ followed by the descriptions of the tags grouped by category. \refitem cfg_template_relations TEMPLATE_RELATIONS \refitem cfg_toc_expand TOC_EXPAND \refitem cfg_treeview_width TREEVIEW_WIDTH +\refitem cfg_typedef_hides_struct TYPEDEF_HIDES_STRUCT \refitem cfg_uml_look UML_LOOK \refitem cfg_use_htags USE_HTAGS \refitem cfg_use_pdflatex USE_PDFLATEX @@ -522,6 +523,17 @@ followed by the descriptions of the tags grouped by category. \c NO to prevent subgrouping. Alternatively, this can be done per class using the \ref cmdnosubgrouping "\\nosubgrouping" command. +\anchor cfg_typedef_hides_struct +<dt>\c TYPEDEF_HIDES_STRUCT <dd> + \addindex TYPEDEF_HIDES_STRUCT + When \c TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct (or union) is + documented as struct with the name of the typedef. So + <code>typedef struct TypeS {} TypeT</code>, will appear in the documentation as a struct + with name \c TypeT. When disabled the typedef will appear as a member of a file, + namespace, or class. And the struct will be named \c TypeS. This can typically + be useful for C code where the coding convention is that all structs are + typedef'ed and only the typedef is referenced never the struct's name. + </dl> \section config_build Build related options |