diff options
author | dimitri <dimitri@afe2bf4a-e733-0410-8a33-86f594647bc7> | 2000-08-29 16:55:26 (GMT) |
---|---|---|
committer | dimitri <dimitri@afe2bf4a-e733-0410-8a33-86f594647bc7> | 2000-08-29 16:55:26 (GMT) |
commit | 26ded37d33ae68d85d5ae4b2e5555ff6ed944a44 (patch) | |
tree | 6cbbe764d1beb5389d2e9247c672b7af04684260 /doc | |
parent | 8726fc640f878611e395b1d821661cff56a49e13 (diff) | |
download | Doxygen-26ded37d33ae68d85d5ae4b2e5555ff6ed944a44.zip Doxygen-26ded37d33ae68d85d5ae4b2e5555ff6ed944a44.tar.gz Doxygen-26ded37d33ae68d85d5ae4b2e5555ff6ed944a44.tar.bz2 |
Release-1.2.1-20000829
Diffstat (limited to 'doc')
-rw-r--r-- | doc/commands.doc | 2 | ||||
-rw-r--r-- | doc/faq.doc | 6 | ||||
-rw-r--r-- | doc/history.doc | 2 | ||||
-rw-r--r-- | doc/trouble.doc | 2 |
4 files changed, 6 insertions, 6 deletions
diff --git a/doc/commands.doc b/doc/commands.doc index 80b032b..46f01f4 100644 --- a/doc/commands.doc +++ b/doc/commands.doc @@ -282,7 +282,7 @@ Doxygen. Unrecognized commands are treated as normal text. (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 - \fn command. The argument ends at the end of the line. + \\fn command. The argument ends at the end of the line. \par Example: \verbinclude func.h diff --git a/doc/faq.doc b/doc/faq.doc index 0817742..4606a19 100644 --- a/doc/faq.doc +++ b/doc/faq.doc @@ -39,12 +39,12 @@ You should use the \\mainpage command inside a comment block like this: In order for global functions, variables, enums, typedefs, and defines to be documented you should document the file in which these commands are -located using a comment block containing a \file (or @file) +located using a comment block containing a \\file (or \@file) command. Alternatively, you can put all members in a group (or module) -using the \ingroup command and then document the group using a comment -block containing the \defgroup command. +using the \\ingroup command and then document the group using a comment +block containing the \\defgroup command. <li><b>How can I avoid that some code fragment is parsed by Doxyen?</b> <p> diff --git a/doc/history.doc b/doc/history.doc index beee457..ddded0a 100644 --- a/doc/history.doc +++ b/doc/history.doc @@ -111,7 +111,7 @@ special <code>//!</code> C++ line comments. <li>Unrelated members can now be documented. A page containing a list of these members is generated. -<li>Added an <code>\include</code> command to insert blocks of source code +<li>Added an <code>\\include</code> command to insert blocks of source code into the documentation. <li>Warnings are generated for members that are undocumented. <li>You can now specify your own HTML headers and footers for the diff --git a/doc/trouble.doc b/doc/trouble.doc index 1f309bc..6e7be24 100644 --- a/doc/trouble.doc +++ b/doc/trouble.doc @@ -62,7 +62,7 @@ documentation, because of possible ambiguities or lack of information about the context in which the code fragment is found. <li>It is not possible to insert a non-member function f in a class A - using the \relates command, if class A already has a member with name f + using the \\relates command, if class A already has a member with name f and the same argument list. <li>There is only very limited support for member specialization at the moment. It only works if there is a specialized template class as |