diff options
author | dimitri <dimitri@afe2bf4a-e733-0410-8a33-86f594647bc7> | 2003-08-24 20:42:56 (GMT) |
---|---|---|
committer | dimitri <dimitri@afe2bf4a-e733-0410-8a33-86f594647bc7> | 2003-08-24 20:42:56 (GMT) |
commit | 77a2ce8e15c967422cb1ff01dc78f5d9b1892c3d (patch) | |
tree | bfd280ef12015bf793b71236c30364c6618cbaf8 /doc/commands.doc | |
parent | d09056a74447fe1c841ffd469986afdffd99765b (diff) | |
download | Doxygen-77a2ce8e15c967422cb1ff01dc78f5d9b1892c3d.zip Doxygen-77a2ce8e15c967422cb1ff01dc78f5d9b1892c3d.tar.gz Doxygen-77a2ce8e15c967422cb1ff01dc78f5d9b1892c3d.tar.bz2 |
Release-1.3.3-20030824
Diffstat (limited to 'doc/commands.doc')
-rw-r--r-- | doc/commands.doc | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/doc/commands.doc b/doc/commands.doc index 073e3d9..1a6d8e5 100644 --- a/doc/commands.doc +++ b/doc/commands.doc @@ -107,6 +107,7 @@ documentation: \refitem cmdpre \\pre \refitem cmdref \\ref \refitem cmdrelates \\relates +\refitem cmdrelatesalso \\relatesalso \refitem cmdremarks \\remarks \refitem cmdreturn \\return \refitem cmdretval \\retval @@ -553,6 +554,24 @@ See section \ref memgroup for an example. \endhtmlonly <hr> +\section cmdrelatesalso \relatesalso <name> + + \addindex \\relatesalso + This command can be used in the documentation of a non-member function + \<name\>. It puts the function both inside the `related function' section + of the class documentation as well as leaving its normal file documentation + location. This command is useful for documenting + non-friend functions that are nevertheless strongly coupled to a certain + class. It only works for functions. + + \par Example: + \verbinclude relates.cpp + \htmlonly + Click <a href="$(DOXYGEN_DOCDIR)/examples/relates/html/globals.html">here</a> + for the corresponding HTML documentation that is generated by doxygen. + \endhtmlonly + +<hr> \section cmdshowinitializer \showinitializer \addindex \\showinitializer |