summaryrefslogtreecommitdiffstats
path: root/doc/faq.doc
diff options
context:
space:
mode:
authoralbert-github <albert.tests@gmail.com>2018-03-06 15:58:30 (GMT)
committeralbert-github <albert.tests@gmail.com>2018-03-06 15:58:30 (GMT)
commitec0e5078b3a9db1f24079257287f7aee9e721093 (patch)
treebc42d7e4750150de143ef334bdfc2af969b6981b /doc/faq.doc
parentfd2e30508f50c2fe84d3619eaa1575545a25b1d3 (diff)
downloadDoxygen-ec0e5078b3a9db1f24079257287f7aee9e721093.zip
Doxygen-ec0e5078b3a9db1f24079257287f7aee9e721093.tar.gz
Doxygen-ec0e5078b3a9db1f24079257287f7aee9e721093.tar.bz2
Small documentation corrections
Diffstat (limited to 'doc/faq.doc')
-rw-r--r--doc/faq.doc8
1 files changed, 4 insertions, 4 deletions
diff --git a/doc/faq.doc b/doc/faq.doc
index bbad8c0..ea47b1c 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 <code>\#include</code> 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".