Skip to content

Commit

Permalink
Small documentation corrections
Browse files Browse the repository at this point in the history
  • Loading branch information
albert-github committed Mar 6, 2018
1 parent fd2e305 commit ec0e507
Show file tree
Hide file tree
Showing 15 changed files with 35 additions and 35 deletions.
4 changes: 2 additions & 2 deletions doc/arch.doc
Expand Up @@ -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.

<h3>C Preprocessor</h3>

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.
Expand Down
2 changes: 1 addition & 1 deletion doc/commands.doc
Expand Up @@ -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".
Expand Down
4 changes: 2 additions & 2 deletions doc/customize.doc
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
8 changes: 4 additions & 4 deletions doc/docblocks.doc
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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.

Expand Down Expand Up @@ -595,7 +595,7 @@ before the command.

<!--
To use your own keywords you an map these keyword to the recognized commands
using the \ref cfg_tcl_subs "TCL_SUBST" entry in the config file.
using the \ref cfg_tcl_subs "TCL_SUBST" entry in the configuration file.
The entry contain a list of word-keyword mappings. To use the itcl::*
commands without the leading namespace use p.e.:

Expand Down
4 changes: 2 additions & 2 deletions doc/doxygen_usage.doc
Expand Up @@ -80,8 +80,8 @@ doxygen -w html header.html footer.html stylesheet.css <config_file>
doxygen -w latex header.tex footer.tex doxygen.sty <config_file>
\endverbatim
If you need non-default options (for instance to use extra \LaTeX packages)
you need to make a config file with those options set correctly and then specify
that config file after the generated files (make a backup of the configuration
you need to make a configuration file with those options set correctly and then specify
that configuration file after the generated files (make a backup of the configuration
file first so you don't loose it in case you forget to specify one of the
output files).
<li>For RTF output, you can generate the default style sheet file (see
Expand Down
4 changes: 2 additions & 2 deletions doc/extsearch.doc
Expand Up @@ -58,7 +58,7 @@ browser via an URL starting with http:)

How to setup a web server is outside the scope of this document,
but if you for instance have Apache installed, you could simply copy the
`doxysearch.cgi` file from doxygen's `bin` dir to the `cgi-bin` of the
`doxysearch.cgi` file from doxygen's `bin` directory to the `cgi-bin` directory of the
Apache web server. Read the <a href="http://httpd.apache.org/docs/2.2/howto/cgi.html">apache documentation</a> for details.

To test if `doxysearch.cgi` is accessible start your web browser and
Expand All @@ -73,7 +73,7 @@ You should get the following message:
If you use Internet Explorer you may be prompted to download a file,
which will then contain this message.

Since we didn't create or install a doxysearch.db it is ok for the test to
Since we didn't create or install a doxysearch.db it is OK for the test to
fail for this reason. How to correct this is discussed in the next section.

Before continuing with the next section add the above
Expand Down
8 changes: 4 additions & 4 deletions doc/faq.doc
Expand Up @@ -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
Expand Down Expand Up @@ -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?
Expand Down Expand Up @@ -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".
Expand Down
2 changes: 1 addition & 1 deletion doc/formulas.doc
Expand Up @@ -32,7 +32,7 @@ have the following tools installed
For the HTML output there is also an alternative solution using
<a href="https://www.mathjax.org">MathJax</a> which does not
require the above tools. If you enable \ref cfg_use_mathjax "USE_MATHJAX" in
the config then the latex formulas will be copied to the HTML "as is" and a
the configuration then the latex formulas will be copied to the HTML "as is" and a
client side javascript will parse them and turn them into (interactive) images.

There are three ways to include formulas in the documentation.
Expand Down
4 changes: 2 additions & 2 deletions doc/install.doc
Expand Up @@ -203,13 +203,13 @@ of the GraphViz package to render nicer diagrams, see the
\ref cfg_have_dot "HAVE_DOT" option in the configuration file.

If you want to produce compressed HTML files (see \ref
cfg_generate_htmlhelp "GENERATE_HTMLHELP") in the config file, then
cfg_generate_htmlhelp "GENERATE_HTMLHELP") in the configuration file, then
you need the Microsoft HTML help workshop.
You can download it from
<a href="http://www.microsoft.com/en-us/download/details.aspx?id=21138">Microsoft</a>.

If you want to produce Qt Compressed Help files (see \ref
cfg_qhg_location "QHG_LOCATION") in the config file, then
cfg_qhg_location "QHG_LOCATION") in the configuration file, then
you need qhelpgenerator which is part of Qt.
You can download Qt from <a href="http://qt-project.org/downloads">Qt Software Downloads</a>.

Expand Down
2 changes: 1 addition & 1 deletion doc/markdown.doc
Expand Up @@ -515,7 +515,7 @@ and in other sections that need to be processed without changes

Markdown allows both a single tab or 4 spaces to start a code block.
Since doxygen already replaces tabs by spaces before doing Markdown
processing, the effect will only be same if TAB_SIZE in the config file
processing, the effect will only be same if TAB_SIZE in the configuration file
has been set to 4. When it is set to a higher value spaces will be
present in the code block. A lower value will prevent a single tab to be
interpreted as the start of a code block.
Expand Down
4 changes: 2 additions & 2 deletions doc/preprocessing.doc
Expand Up @@ -55,7 +55,7 @@ both statements, i.e.:
\endverbatim

In case you want to expand the \c CONST_STRING macro, you should set the
\ref cfg_macro_expansion "MACRO_EXPANSION" tag in the config file
\ref cfg_macro_expansion "MACRO_EXPANSION" tag in the configuration file
to \c YES. Then the result after preprocessing becomes:

\verbatim
Expand Down Expand Up @@ -130,7 +130,7 @@ without macro expansion doxygen will get confused, but we may not want to
expand the \c REFIID macro, because it is documented and the user that reads
the documentation should use it when implementing the interface.

By setting the following in the config file:
By setting the following in the configuration file:

\verbatim
ENABLE_PREPROCESSING = YES
Expand Down
10 changes: 5 additions & 5 deletions doc/searching.doc
Expand Up @@ -35,7 +35,7 @@ has its own advantages and disadvantages:
required to make it work.

To enable it set
\ref cfg_searchengine "SEARCHENGINE" to \c YES in the config file
\ref cfg_searchengine "SEARCHENGINE" to \c YES in the configuration file
and make sure \ref cfg_server_based_search "SERVER_BASED_SEARCH" is set
to \c NO.

Expand All @@ -53,7 +53,7 @@ has its own advantages and disadvantages:

To enable this set both
\ref cfg_searchengine "SEARCHENGINE" and
\ref cfg_server_based_search "SERVER_BASED_SEARCH" to \c YES in the config
\ref cfg_server_based_search "SERVER_BASED_SEARCH" to \c YES in the configuration
file and set \ref cfg_external_search "EXTERNAL_SEARCH" to \c NO.

Advantages over the client side search engine are that it provides full
Expand Down Expand Up @@ -100,9 +100,9 @@ has its own advantages and disadvantages:
and Windows even supports it natively.

To enable this set \ref cfg_generate_htmlhelp "GENERATE_HTMLHELP" to \c YES
in the config file. To let doxygen compile the HTML Help file for you,
in the configuration file. To let doxygen compile the HTML Help file for you,
you also need to specify the path to the HTML compiler (hhc.exe) using the
\ref cfg_hhc_location "HHC_LOCATION" config option and the name of the
\ref cfg_hhc_location "HHC_LOCATION" configuration option and the name of the
resulting CHM file using \ref cfg_chm_file "CHM_FILE".

An advantage of this method is that the result is a single file that can
Expand All @@ -122,7 +122,7 @@ has its own advantages and disadvantages:
provided by Apple).

To enable the creation of doc sets set \ref cfg_generate_docset "GENERATE_DOCSET"
to \c YES in the config file. There are a couple of other doc set related
to \c YES in the configuration file. There are a couple of other doc set related
options you may want to set. After doxygen has finished you will find
a Makefile in the HTML output directory. Running "make install" on this
Makefile will compile and install the doc set.
Expand Down
2 changes: 1 addition & 1 deletion doc/starting.doc
Expand Up @@ -77,7 +77,7 @@ You can probably leave the values of most tags in a generated template
configuration file to their default value. See section \ref config for
more details about the configuration file.

If you do not wish to edit the config file with a text editor, you should
If you do not wish to edit the configuration file with a text editor, you should
have a look at \ref doxywizard_usage "doxywizard", which is a GUI
front-end that can create, read and write doxygen configuration files,
and allows setting configuration options by entering them via dialogs.
Expand Down
2 changes: 1 addition & 1 deletion doc/trouble.doc
Expand Up @@ -113,7 +113,7 @@ always try to include the following information in your bug report:
- It is usually a good idea to send along the configuration file as well,
but please use doxygen with the <code>-s</code> flag while generating it
to keep it small (use <code>doxygen -s -u [configName]</code> to strip
the comments from an existing config file).
the comments from an existing configuration file).
- The easiest (and often the only) way for me to fix bugs is if you can
attach a small example demonstrating the problem you have to the bug report, so I can
reproduce it on my machine. Please make sure the example is valid
Expand Down
10 changes: 5 additions & 5 deletions src/config.xml
Expand Up @@ -125,7 +125,7 @@ SEARCHENGINE = YES
\endverbatim
To regenerate the Qt-1.44 documentation from the sources, you could use the
following config file:
following configuration file:
\verbatim
PROJECT_NAME = Qt
OUTPUT_DIRECTORY = qt_docs
Expand Down Expand Up @@ -212,7 +212,7 @@ Go to the <a href="commands.html">next</a> section or return to the
<option type='string' id='DOXYFILE_ENCODING' format='string' defval='UTF-8'>
<docs>
<![CDATA[
This tag specifies the encoding used for all characters in the config file that
This tag specifies the encoding used for all characters in the configuration file that
follow. The default is UTF-8 which is also the encoding used for all text before
the first occurrence of this tag. Doxygen uses \c libiconv (or the iconv built into
\c libc) for the transcoding. See https://www.gnu.org/software/libiconv/ for the list of
Expand Down Expand Up @@ -1606,7 +1606,7 @@ to disable this feature.
<br>
To use it do the following:
-# Install the latest version of \c global
-# Enable \ref cfg_source_browser "SOURCE_BROWSER" and \c USE_HTAGS in the config file
-# Enable \ref cfg_source_browser "SOURCE_BROWSER" and \c USE_HTAGS in the configuration file
-# Make sure the \ref cfg_input "INPUT" points to the root of the source tree
-# Run \c doxygen as normal
<br>
Expand Down Expand Up @@ -2772,7 +2772,7 @@ or
<docs>
<![CDATA[
Load stylesheet definitions from file. Syntax is similar to doxygen's
config file, i.e. a series of assignments. You only have to provide
configuration file, i.e. a series of assignments. You only have to provide
replacements, missing definitions are set to their default value.
<br>
See also section \ref doxygen_usage for information on how to generate
Expand All @@ -2785,7 +2785,7 @@ or
<docs>
<![CDATA[
Set optional variables used in the generation of an RTF document.
Syntax is similar to doxygen's config file.
Syntax is similar to doxygen's configuration file.
A template extensions file can be generated using
<code>doxygen -e rtf extensionFile</code>.
]]>
Expand Down

0 comments on commit ec0e507

Please sign in to comment.