diff options
| author | Dimitri van Heesch <dimitri@stack.nl> | 2018-04-22 09:48:05 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-04-22 09:48:05 (GMT) |
| commit | 64c77849cbc15b8bfb14bf5dd9ebab9e0d64453f (patch) | |
| tree | a2b7fe529c729547995e7280008f51759bad6097 /doc/faq.doc | |
| parent | 03b86f1ec081b9a4562707bc584b3cd8afefff9b (diff) | |
| parent | ec0e5078b3a9db1f24079257287f7aee9e721093 (diff) | |
| download | Doxygen-64c77849cbc15b8bfb14bf5dd9ebab9e0d64453f.zip Doxygen-64c77849cbc15b8bfb14bf5dd9ebab9e0d64453f.tar.gz Doxygen-64c77849cbc15b8bfb14bf5dd9ebab9e0d64453f.tar.bz2 | |
Merge pull request #678 from albert-github/feature/bug_docu_2
Small documentation corrections
Diffstat (limited to 'doc/faq.doc')
| -rw-r--r-- | doc/faq.doc | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/doc/faq.doc b/doc/faq.doc index 50dd7b1..a91a2f5 100644 --- a/doc/faq.doc +++ b/doc/faq.doc @@ -43,14 +43,14 @@ You should use the \ref cmdmainpage "\\mainpage" command inside a comment block <ol> <li>Is your class / file / namespace documented? If not, it will not be extracted from the sources unless \ref cfg_extract_all "EXTRACT_ALL" is set to \c YES - in the config file. + in the configuration file. <li>Are the members private? If so, you must set \ref cfg_extract_private "EXTRACT_PRIVATE" to \c YES to make them appear in the documentation. <li>Is there a function macro in your class that does not end with a semicolon (e.g. MY_MACRO())? If so then you have to instruct doxygen's preprocessor to remove it. - This typically boils down to the following settings in the config file: + This typically boils down to the following settings in the configuration file: \verbatim ENABLE_PREPROCESSING = YES @@ -110,7 +110,7 @@ around the blocks that should be hidden and put: \verbatim PREDEFINED = DOXYGEN_SHOULD_SKIP_THIS \endverbatim -in the config file then all blocks should be skipped by doxygen as long +in the configuration file then all blocks should be skipped by doxygen as long as \ref cfg_enable_preprocessing "ENABLE_PREPROCESSING" is set to `YES`. \section faq_code_inc How can I change what is after the \#include in the class documentation? @@ -235,7 +235,7 @@ should send me a code fragment that triggers the message. To work around the problem, put some line-breaks into your file, split it up into smaller parts, or exclude it from the input using EXCLUDE. -\section faq_latex When running make in the latex dir I get "TeX capacity exceeded". Now what? +\section faq_latex When running make in the latex directory I get "TeX capacity exceeded". Now what? You can edit the texmf.cfg file to increase the default values of the various buffers and then run "texconfig init". |