diff options
Diffstat (limited to 'doc/commands.doc')
| -rw-r--r-- | doc/commands.doc | 70 |
1 files changed, 64 insertions, 6 deletions
diff --git a/doc/commands.doc b/doc/commands.doc index f61022a..7450d91 100644 --- a/doc/commands.doc +++ b/doc/commands.doc @@ -83,6 +83,7 @@ documentation: \refitem cmdenum \\enum \refitem cmdexample \\example \refitem cmdexception \\exception +\refitem cmdextends \\extends \refitem cmdfdollar \\f\$ \refitem cmdfbropen \\f[ \refitem cmdfbrclose \\f] @@ -97,6 +98,7 @@ documentation: \refitem cmdif \\if \refitem cmdifnot \\ifnot \refitem cmdimage \\image +\refitem cmdimplements \\implements \refitem cmdinclude \\include \refitem cmdincludelineno \\includelineno \refitem cmdingroup \\ingroup @@ -109,6 +111,7 @@ documentation: \refitem cmdlink \\link \refitem cmdmainpage \\mainpage \refitem cmdmanonly \\manonly +\refitem cmdmemberof \\memberof \refitem cmdmsc \\msc \refitem cmdn \\n \refitem cmdname \\name @@ -372,6 +375,23 @@ doxygen. Unrecognized commands are treated as normal text. \sa section \ref cmdinclude "\\include". <hr> +\section cmdextends \\extends <name> + + \addindex \\extends + This command can be used to manually indicate an inheritance relation, + when the programming language does not support this concept natively + (e.g. C). + + The file \c manual.c in the example directory shows how to use this command. + \htmlonly + Click <a href="$(DOXYGEN_DOCDIR)/examples/manual/html/index.html">here</a> + for the corresponding HTML documentation that is generated by doxygen. + \endhtmlonly + + \sa section \ref cmdimplements "\\implements" and section + \ref cmdmemberof "\\memberof" + +<hr> \section cmdfile \\file [<name>] \addindex \\file @@ -456,6 +476,23 @@ doxygen. Unrecognized commands are treated as normal text. \sa section \ref cmdshowinitializer "\\showinitializer". <hr> +\section cmdimplements \\implements <name> + + \addindex \\implements + This command can be used to manually indicate an inheritance relation, + when the programming language does not support this concept natively + (e.g. C). + + The file \c manual.c in the example directory shows how to use this command. + \htmlonly + Click <a href="$(DOXYGEN_DOCDIR)/examples/manual/html/index.html">here</a> + for the corresponding HTML documentation that is generated by doxygen. + \endhtmlonly + + \sa section \ref cmdextends "\\extends" and section + \ref cmdmemberof "\\memberof" + +<hr> \section cmdingroup \\ingroup (<groupname> [<groupname> <groupname>]) \addindex \\ingroup @@ -530,15 +567,36 @@ doxygen. Unrecognized commands are treated as normal text. section \ref cmdpage "\\page". <hr> +\section cmdmemberof \\memberof <name> + + \addindex \\memberof + This command make a function a member of a class in a similar way + as \ref cmdrelates "\\relates" does, only with this command the function + is represented as a real member of the class. + This can be useful when the programming language does not support + the concept of member functions natively (e.g. C). + + The file \c manual.c in the example directory shows how to use this command. + \htmlonly + Click <a href="$(DOXYGEN_DOCDIR)/examples/manual/html/index.html">here</a> + for the corresponding HTML documentation that is generated by doxygen. + \endhtmlonly + + \sa section \ref cmdextends "\\extends" and section + \ref cmdmemberof "\\memberof" + +<hr> \section cmdname \\name (header) -This command turns a comment block into a header -definition of a member group. The -comment block should be followed by a -<code>//\@{ ... //\@}</code> block containing the -members of the group. + \addindex \\name + + This command turns a comment block into a header + definition of a member group. The + comment block should be followed by a + <code>//\@{ ... //\@}</code> block containing the + members of the group. -See section \ref memgroup for an example. + See section \ref memgroup for an example. <hr> \section cmdnamespace \\namespace <name> |