From ec0e5078b3a9db1f24079257287f7aee9e721093 Mon Sep 17 00:00:00 2001 From: albert-github Date: Tue, 6 Mar 2018 16:58:30 +0100 Subject: Small documentation corrections --- doc/arch.doc | 4 ++-- doc/commands.doc | 2 +- doc/customize.doc | 4 ++-- doc/docblocks.doc | 8 ++++---- doc/doxygen_usage.doc | 4 ++-- doc/extsearch.doc | 4 ++-- doc/faq.doc | 8 ++++---- doc/formulas.doc | 2 +- doc/install.doc | 4 ++-- doc/markdown.doc | 2 +- doc/preprocessing.doc | 4 ++-- doc/searching.doc | 10 +++++----- doc/starting.doc | 2 +- doc/trouble.doc | 2 +- src/config.xml | 10 +++++----- 15 files changed, 35 insertions(+), 35 deletions(-) diff --git a/doc/arch.doc b/doc/arch.doc index e5fbbdc..4032c66 100644 --- a/doc/arch.doc +++ b/doc/arch.doc @@ -41,14 +41,14 @@ available through the global functions \c Config_getXXX(), where \c XXX is the type of the option. The argument of these function is a string naming the option as it appears in the configuration file. For instance: \c Config_getBool("GENERATE_TESTLIST") returns a reference to a boolean -value that is \c TRUE if the test list was enabled in the config file. +value that is \c TRUE if the test list was enabled in the configuration file. The function \c readConfiguration() in \c src/doxygen.cpp reads the command line options and then calls the configuration parser.

C Preprocessor

-The input files mentioned in the config file are (by default) fed to the +The input files mentioned in the configuration file are (by default) fed to the C Preprocessor (after being piped through a user defined filter if available). The way the preprocessor works differs somewhat from a standard C Preprocessor. diff --git a/doc/commands.doc b/doc/commands.doc index 12b85db..1c7e7cf 100644 --- a/doc/commands.doc +++ b/doc/commands.doc @@ -697,7 +697,7 @@ Structural indicators command are considered to be internal as well. Only a new section at the same level will end the fragment that is considered internal. - You can use \ref cfg_internal_docs "INTERNAL_DOCS" in the config file + You can use \ref cfg_internal_docs "INTERNAL_DOCS" in the configuration file to show (\c YES) or hide (\c NO) the internal documentation. \sa section \ref cmdendinternal "\\endinternal". diff --git a/doc/customize.doc b/doc/customize.doc index 9ef3891..e2d53db 100644 --- a/doc/customize.doc +++ b/doc/customize.doc @@ -114,7 +114,7 @@ This will create 3 files: referencing those extra files via \ref cfg_html_extra_stylesheet "HTML_EXTRA_STYLESHEET". -You should edit these files and then reference them from the config file. +You should edit these files and then reference them from the configuration file. - \ref cfg_html_header "HTML_HEADER" = \c header.html - \ref cfg_html_footer "HTML_FOOTER" = \c footer.html - \ref cfg_html_extra_stylesheet "HTML_EXTRA_STYLESHEET" = \c my_customdoxygen.css @@ -158,7 +158,7 @@ doxygen -l optionally the name of the layout file can be specified, if omitted \c DoxygenLayout.xml will be used. -The next step is to mention the layout file in the config file +The next step is to mention the layout file in the configuration file \verbatim LAYOUT_FILE = DoxygenLayout.xml \endverbatim diff --git a/doc/docblocks.doc b/doc/docblocks.doc index 81cfdd0..e72ce95 100644 --- a/doc/docblocks.doc +++ b/doc/docblocks.doc @@ -293,7 +293,7 @@ The brief descriptions are included in the member overview of a class, namespace or file and are printed using a small italic font (this description can be hidden by setting \ref cfg_brief_member_desc "BRIEF_MEMBER_DESC" to \c NO in -the config file). By default the brief descriptions become the first +the configuration file). By default the brief descriptions become the first sentence of the detailed descriptions (but this can be changed by setting the \ref cfg_repeat_brief "REPEAT_BRIEF" tag to \c NO). Both the brief and the detailed descriptions are optional @@ -473,7 +473,7 @@ Here is the same example again but now using doxygen style comments: Since python looks more like Java than like C or C++, you should set \ref cfg_optimize_output_java "OPTIMIZE_OUTPUT_JAVA" to \c YES in the -config file. +configuration file. \subsection vhdlblocks Comment blocks in VHDL @@ -503,7 +503,7 @@ Here is an example VHDL file with doxygen comments: To get proper looking output you need to set \ref cfg_optimize_output_vhdl "OPTIMIZE_OUTPUT_VHDL" to \c YES in the -config file. This will also affect a number of other settings. When they +configuration file. This will also affect a number of other settings. When they were not already set correctly doxygen will produce a warning telling which settings where overruled. @@ -595,7 +595,7 @@ before the command.