diff options
author | dimitri <dimitri@afe2bf4a-e733-0410-8a33-86f594647bc7> | 2008-01-23 21:30:39 (GMT) |
---|---|---|
committer | dimitri <dimitri@afe2bf4a-e733-0410-8a33-86f594647bc7> | 2008-01-23 21:30:39 (GMT) |
commit | 38c6a14b15d87348076be142abea8663009ace82 (patch) | |
tree | d75127a33593cfe4d77e951e6df541294dc1e9b4 /doc/commands.doc | |
parent | d37b4be374f200ce57ee228d0f33e52e10add15f (diff) | |
download | Doxygen-38c6a14b15d87348076be142abea8663009ace82.zip Doxygen-38c6a14b15d87348076be142abea8663009ace82.tar.gz Doxygen-38c6a14b15d87348076be142abea8663009ace82.tar.bz2 |
Release-1.5.4-20080123
Diffstat (limited to 'doc/commands.doc')
-rw-r--r-- | doc/commands.doc | 23 |
1 files changed, 22 insertions, 1 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 |