summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/arch.doc4
-rw-r--r--doc/commands.doc2
-rw-r--r--doc/customize.doc4
-rw-r--r--doc/docblocks.doc8
-rw-r--r--doc/doxygen_usage.doc4
-rw-r--r--doc/extsearch.doc4
-rw-r--r--doc/faq.doc8
-rw-r--r--doc/formulas.doc2
-rw-r--r--doc/install.doc4
-rw-r--r--doc/markdown.doc2
-rw-r--r--doc/preprocessing.doc4
-rw-r--r--doc/searching.doc10
-rw-r--r--doc/starting.doc2
-rw-r--r--doc/trouble.doc2
14 files changed, 30 insertions, 30 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.
<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.
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.
<!--
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.:
diff --git a/doc/doxygen_usage.doc b/doc/doxygen_usage.doc
index bcb14e8..20a5763 100644
--- a/doc/doxygen_usage.doc
+++ b/doc/doxygen_usage.doc
@@ -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
diff --git a/doc/extsearch.doc b/doc/extsearch.doc
index 99a7219..36116ff 100644
--- a/doc/extsearch.doc
+++ b/doc/extsearch.doc
@@ -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
@@ -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
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".
diff --git a/doc/formulas.doc b/doc/formulas.doc
index 1649c19..ee4ff61 100644
--- a/doc/formulas.doc
+++ b/doc/formulas.doc
@@ -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.
diff --git a/doc/install.doc b/doc/install.doc
index 6db8102..f981431 100644
--- a/doc/install.doc
+++ b/doc/install.doc
@@ -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>.
diff --git a/doc/markdown.doc b/doc/markdown.doc
index e5aebd1..a0e7574 100644
--- a/doc/markdown.doc
+++ b/doc/markdown.doc
@@ -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.
diff --git a/doc/preprocessing.doc b/doc/preprocessing.doc
index 30d4cf3..882e60d 100644
--- a/doc/preprocessing.doc
+++ b/doc/preprocessing.doc
@@ -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
@@ -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
diff --git a/doc/searching.doc b/doc/searching.doc
index 00c6141..cb6b84a 100644
--- a/doc/searching.doc
+++ b/doc/searching.doc
@@ -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.
@@ -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
@@ -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
@@ -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.
diff --git a/doc/starting.doc b/doc/starting.doc
index c869867..e39aa25 100644
--- a/doc/starting.doc
+++ b/doc/starting.doc
@@ -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.
diff --git a/doc/trouble.doc b/doc/trouble.doc
index 9584c0c..c99c407 100644
--- a/doc/trouble.doc
+++ b/doc/trouble.doc
@@ -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
generated by cgit v0.12 at 2024-10-31 17:01:19 (GMT)