summaryrefslogtreecommitdiffstats
path: root/doc/commands.doc
diff options
context:
space:
mode:
authordimitri <dimitri@afe2bf4a-e733-0410-8a33-86f594647bc7>2002-07-07 17:23:26 (GMT)
committerdimitri <dimitri@afe2bf4a-e733-0410-8a33-86f594647bc7>2002-07-07 17:23:26 (GMT)
commitbcbf69496a8e7e703ecf4fb6e5de264f86ebea84 (patch)
treef08f27e02ce20e8ca59117d6d02be98fbe3c8c24 /doc/commands.doc
parent46570cfd109829f87a17c46e32006f901b9026f4 (diff)
downloadDoxygen-bcbf69496a8e7e703ecf4fb6e5de264f86ebea84.zip
Doxygen-bcbf69496a8e7e703ecf4fb6e5de264f86ebea84.tar.gz
Doxygen-bcbf69496a8e7e703ecf4fb6e5de264f86ebea84.tar.bz2
Release-1.2.16-20020707
Diffstat (limited to 'doc/commands.doc')
-rw-r--r--doc/commands.doc18
1 files changed, 13 insertions, 5 deletions
diff --git a/doc/commands.doc b/doc/commands.doc
index 972fe90..ee52cbe 100644
--- a/doc/commands.doc
+++ b/doc/commands.doc
@@ -325,14 +325,21 @@ doxygen. Unrecognized commands are treated as normal text.
\addindex \fn
Indicates that a comment block contains documentation for a function
- (either global or as a member of a class). This command is needed if a
- comment block is \e not placed in front of the function declaration
- or definition. If your comment block \e is in front of the function
+ (either global or as a member of a class). This command is \em only
+ needed if a comment block is \e not placed in front (or behind)
+ the function declaration or definition.
+
+ If your comment block \e is in front of the function
declaration or definition this command can (and to avoid redundancy
should) be ommitted.
- A full function declaration should be specified after the
- \\fn command. The argument ends at the end of the line.
+ A full function declaration including arguments should be specified after the
+ \\fn command on a \e single line, since the argument ends at the end
+ of the line!
+
+ \warning Do not use this command
+ if it is not absolutely needed, since it will lead to duplication of
+ information and thus to errors.
\par Example:
\verbinclude func.h
@@ -341,6 +348,7 @@ doxygen. Unrecognized commands are treated as normal text.
for the corresponding HTML documentation that is generated by doxygen.
\endhtmlonly
+
\sa section \ref cmdvar "\\var" and \ref cmdtypedef "\\typedef".
<hr>