diff options
| author | Dimitri van Heesch <dimitri@stack.nl> | 2002-12-24 19:52:54 (GMT) |
|---|---|---|
| committer | Dimitri van Heesch <dimitri@stack.nl> | 2002-12-24 19:52:54 (GMT) |
| commit | 04dd14e8f14f65481ef7ed7a29e79a30c5fe301d (patch) | |
| tree | 74b9c804cdbc689945d204f1c854e9bfa1ec5c01 /doc/faq.doc | |
| parent | 1a8ff6f0e75b0db2a4ff1f5eb63631c94085b01e (diff) | |
| download | Doxygen-04dd14e8f14f65481ef7ed7a29e79a30c5fe301d.zip Doxygen-04dd14e8f14f65481ef7ed7a29e79a30c5fe301d.tar.gz Doxygen-04dd14e8f14f65481ef7ed7a29e79a30c5fe301d.tar.bz2 | |
Release-1.3-rc2-20021224
Diffstat (limited to 'doc/faq.doc')
| -rw-r--r-- | doc/faq.doc | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/doc/faq.doc b/doc/faq.doc index 56b1039..576daaf 100644 --- a/doc/faq.doc +++ b/doc/faq.doc @@ -62,7 +62,8 @@ PREDEFINED = MY_MACRO()= manual for more information. </ol> -<li><b>When I set EXTRACT_ALL to NO none of my functions are shown in the documentation.</b></li> +<li><b>When I set EXTRACT_ALL to NO none of my functions are shown in the + documentation.</b></li> In order for global functions, variables, enums, typedefs, and defines to be documented you should document the file in which these commands are @@ -72,6 +73,9 @@ 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. + +For member functions or functions that are part of a namespace you should +document either the class or namespace. <li><b>How can I make doxygen ignore some code fragment?</b> <p> |