diff options
| author | dimitri <dimitri@afe2bf4a-e733-0410-8a33-86f594647bc7> | 2001-02-25 17:49:47 (GMT) |
|---|---|---|
| committer | dimitri <dimitri@afe2bf4a-e733-0410-8a33-86f594647bc7> | 2001-02-25 17:49:47 (GMT) |
| commit | 69fbf29b9b2be1bdf9132adb799f31ab343a642e (patch) | |
| tree | 0673a1c66696ceb0da0191a0e834b85eef8c50a2 /doc/commands.doc | |
| parent | 863353b89b228b87789e6d6c9257605acd796fff (diff) | |
| download | Doxygen-69fbf29b9b2be1bdf9132adb799f31ab343a642e.zip Doxygen-69fbf29b9b2be1bdf9132adb799f31ab343a642e.tar.gz Doxygen-69fbf29b9b2be1bdf9132adb799f31ab343a642e.tar.bz2 | |
Release-1.2.5-20010225
Diffstat (limited to 'doc/commands.doc')
| -rw-r--r-- | doc/commands.doc | 8 |
1 files changed, 6 insertions, 2 deletions
diff --git a/doc/commands.doc b/doc/commands.doc index 5a6bb82..92491ae 100644 --- a/doc/commands.doc +++ b/doc/commands.doc @@ -280,8 +280,12 @@ 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 located before the function declaration - or definition. A full function declaration should be specified after the + 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 + 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. \par Example: |