diff options
Diffstat (limited to 'doc/config.doc')
-rw-r--r-- | doc/config.doc | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/doc/config.doc b/doc/config.doc index 4b6b949..3c8a6b2 100644 --- a/doc/config.doc +++ b/doc/config.doc @@ -543,13 +543,13 @@ sources. Doxygen will then generate output that is tailored for VHDL. \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. + When \c TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum + is documented as struct, union, or enum 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 in case the coding convention dictates that all compound + types are typedef'ed and only the typedef is referenced, never the tag name. </dl> @@ -1189,7 +1189,7 @@ FILE_VERSION_INFO = "cleartool desc -fmt \%Vn" on Windows. The HTML Help Workshop contains a compiler that can convert all HTML output - generated by doxygen into a single compressed HTML file (.chm). Compressed + generated by doxygen into a single compiled HTML file (.chm). Compiled HTML files are now used as the Windows 98 help format, and will replace the old Windows help format (.hlp) on all Windows platforms in the future. Compressed HTML files also contain an index, a table of contents, |