summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorDimitri van Heesch <dimitri@stack.nl>2008-01-23 21:30:39 (GMT)
committerDimitri van Heesch <dimitri@stack.nl>2008-01-23 21:30:39 (GMT)
commit0e922bf35ccff96ec03f22df607f3b44303206eb (patch)
treed75127a33593cfe4d77e951e6df541294dc1e9b4 /doc
parent974f9e82c84412f1b51aff41f21f635f5fb84d9d (diff)
downloadDoxygen-0e922bf35ccff96ec03f22df607f3b44303206eb.zip
Doxygen-0e922bf35ccff96ec03f22df607f3b44303206eb.tar.gz
Doxygen-0e922bf35ccff96ec03f22df607f3b44303206eb.tar.bz2
Release-1.5.4-20080123
Diffstat (limited to 'doc')
-rw-r--r--doc/commands.doc23
-rw-r--r--doc/config.doc16
-rw-r--r--doc/output.doc2
3 files changed, 31 insertions, 10 deletions
diff --git a/doc/commands.doc b/doc/commands.doc
index 05f812f..7843999 100644
--- a/doc/commands.doc
+++ b/doc/commands.doc
@@ -88,6 +88,7 @@ documentation:
\refitem cmdfcurlyclose \\f}
\refitem cmdfile \\file
\refitem cmdfn \\fn
+\refitem cmdheaderfile \\headerfile
\refitem cmdhideinitializer \\hideinitializer
\refitem cmdhtmlinclude \\htmlinclude
\refitem cmdhtmlonly \\htmlonly
@@ -259,7 +260,9 @@ doxygen. Unrecognized commands are treated as normal text.
on the default include path (like \<X11/X.h\>). With the \<header-name\>
argument you can also specify how the include statement should look like,
by adding either quotes or sharp brackets around the name.
- Sharp brackets are used if just the name is given.
+ Sharp brackets are used if just the name is given. Note that the
+ last two arguments can also specified using
+ the \ref cmdheaderfile "\\headerfile" command.
\par Example:
\verbinclude class.h
@@ -421,6 +424,24 @@ doxygen. Unrecognized commands are treated as normal text.
\sa section \ref cmdvar "\\var" and \ref cmdtypedef "\\typedef".
<hr>
+\section cmdheaderfile \\headerfile <header-file> [<header-name>]
+
+ \addindex \\headerfile
+ Intended to be used for class, struct, or union documentation, where
+ the documentation is in front of the definition. The arguments of
+ this command are the same as the second and third argument of
+ \ref cmdclass "\\cmdclass".
+ The header-file name refers to the file that should by included by the
+ application to obtain the definition of the class, struct, or union.
+ The \<header-name\> argument can be used to overwrite the
+ name of the link that is used in the class documentation to something other
+ than \<header-file\>. This can be useful if the include name is not located
+ on the default include path (like \<X11/X.h\>). With the \<header-name\>
+ argument you can also specify how the include statement should look like,
+ by adding either quotes or sharp brackets around the name.
+ Sharp brackets are used if just the name is given.
+
+<hr>
\section cmdhideinitializer \\hideinitializer
\addindex \\hideinitializer
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,
diff --git a/doc/output.doc b/doc/output.doc
index 225d796..f5a8d3d 100644
--- a/doc/output.doc
+++ b/doc/output.doc
@@ -39,7 +39,7 @@ The following output formats are \e directly supported by doxygen:
The following output formats are \e indirectly supported by doxygen:
<dl>
-<dt><b>Compressed HTML</b> (a.k.a. Windows 98 help)
+<dt><b>Compiled HTML Help</b> (a.k.a. Windows 98 help)
<dd>Generated by Microsoft's HTML Help workshop from the HTML output if
\c GENERATE_HTMLHELP is set to \c YES.
<dt><b>PostScript</b>