Skip to content

Commit

Permalink
Spelling correction
Browse files Browse the repository at this point in the history
Some small spelling and consistency corrections.
  • Loading branch information
albert-github committed Jun 11, 2024
1 parent 2670570 commit 1bda21e
Show file tree
Hide file tree
Showing 8 changed files with 19 additions and 19 deletions.
2 changes: 1 addition & 1 deletion doc/extsearch.dox
Original file line number Diff line number Diff line change
Expand Up @@ -259,7 +259,7 @@ have to be decoded before they can be used.
When invoking the search engine as shown in the previous subsection, it should reply with
the results. The format of the reply is
<a href="https://en.wikipedia.org/wiki/JSONP">JSON with padding</a>, which is basically
a javascript struct wrapped in a function call. The name of function should be the name of
a JavaScript struct wrapped in a function call. The name of function should be the name of
the callback (as passed with the *cb* field in the query).

With the example query as shown the previous subsection the main structure of the reply should
Expand Down
2 changes: 1 addition & 1 deletion doc/faq.dox
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,7 @@ in the HEAD section of the HTML page.
In the past (prior to version 1.9.2) doxygen used a part of Qt 2.x for various
utility classes. These have been replaced by STL container classes in the meantime.

The GUI front-end called Doxywizard is based on a modern version of Qt.
The GUI front-end called doxywizard is based on a modern version of Qt.
Doxygen itself can also be used without the GUI.

\section faq_excl_dir How can I exclude all test directories from my directory tree?
Expand Down
2 changes: 1 addition & 1 deletion doc/features.dox
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
structs, unions, templates, variables, functions, typedefs, enums and
defines.
<li>Javadoc (1.1), qdoc3 (partially), and ECMA-334 (C# spec.) compatible.
<li>Comes with a GUI frontend (Doxywizard) to ease editing the options and
<li>Comes with a GUI frontend (doxywizard) to ease editing the options and
run doxygen. The GUI is available on Windows, Linux, and MacOSX.
<li>Automatically generates class and collaboration diagrams in HTML (as clickable
image maps) and \LaTeX (as Encapsulated PostScript images).
Expand Down
2 changes: 1 addition & 1 deletion doc/formulas.dox
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ 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 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.
client side JavaScript will parse them and turn them into (interactive) images.

There are four ways to include formulas in the documentation.
<ol>
Expand Down
2 changes: 1 addition & 1 deletion doc/grouping.dox
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ for each group. These groups are called \ref topics "'topics'" in the documentat
The second mechanism works within a member list of some compound entity,
and is referred to as a \ref memgroup "'member groups'".
For \ref cmdpage "pages" there is a third grouping mechanism referred to
as \ref subpaging "subpaging".
as \ref subpaging.

\section topics Topics

Expand Down
2 changes: 1 addition & 1 deletion doc/install.dox
Original file line number Diff line number Diff line change
Expand Up @@ -210,7 +210,7 @@ cmake -G "NMake Makefiles" ..
nmake
\endverbatim

Note that compiling Doxywizard requires Qt 5.14 or newer
Note that compiling doxywizard requires Qt 5.14 or newer
(see https://doc.qt.io/).

Also read the next section for additional tools you may need to install to run
Expand Down
2 changes: 1 addition & 1 deletion doc/markdown.dox
Original file line number Diff line number Diff line change
Expand Up @@ -767,7 +767,7 @@ contain only one new line, the URL may not contain any newlines.
\subsection mddox_github_alerts Support for GitHub Alerts

In the GitHub version of markdown there is the support for so called alerts, the
syntax is similar to a one level block quote followied by `[!<alert>]` where
syntax is similar to a one level block quote followed by `[!<alert>]` where
`<alert>` can be one of `note`, `warning`, `tip`, `caution` or `important`.
In doxygen these alerts are translated into normal doxygen commands:
- `> [!note]` is translated to \ref cmdnote "\\note"
Expand Down
24 changes: 12 additions & 12 deletions src/config.xml
Original file line number Diff line number Diff line change
Expand Up @@ -1088,7 +1088,7 @@ Go to the <a href="commands.html">next</a> section or return to the
<option type='bool' id='SHOW_GROUPED_MEMB_INC' defval='0'>
<docs>
<![CDATA[
If the \c SHOW_GROUPED_MEMB_INC tag is set to \c YES then Doxygen
If the \c SHOW_GROUPED_MEMB_INC tag is set to \c YES then doxygen
will add for each grouped member an include statement to the documentation,
telling the reader which file to include in order to use the member.
]]>
Expand Down Expand Up @@ -2031,19 +2031,19 @@ doxygen -w html new_header.html new_footer.html new_stylesheet.css YourConfigFil
\ref cfg_html_extra_stylesheet "HTML_EXTRA_STYLESHEET" including the required
HTML tags for each extra stylesheet.
<dt><code>$treeview</code><dd>will be replaced with links to
the javascript and style sheets needed for the navigation tree
the JavaScript and style sheets needed for the navigation tree
(or an empty string when \ref cfg_generate_treeview "GENERATE_TREEVIEW"
is disabled).
<dt><code>$search</code><dd>will be replaced with a links to
the javascript and style sheets needed for the search engine
the JavaScript and style sheets needed for the search engine
(or an empty string when \ref cfg_searchengine "SEARCHENGINE"
is disabled).
<dt><code>$searchbox</code><dd>will be replaced with the HTML code needed for
the search box to be shown
(or an empty string when \ref cfg_searchengine "SEARCHENGINE"
is disabled).
<dt><code>$mathjax</code><dd>will be replaced with a links to
the javascript and style sheets needed for the MathJax feature
the JavaScript and style sheets needed for the MathJax feature
(or an empty string when \ref cfg_use_mathjax "USE_MATHJAX" is disabled).
<dt><code>$relpath^</code><dd>
If \ref cfg_create_subdirs "CREATE_SUBDIRS" is enabled, the command <code>$relpath^</code> can be
Expand Down Expand Up @@ -2770,7 +2770,7 @@ MATHJAX_EXTENSIONS = ams
<option type='string' id='MATHJAX_CODEFILE' format='string' depends='USE_MATHJAX'>
<docs>
<![CDATA[
The \c MATHJAX_CODEFILE tag can be used to specify a file with javascript
The \c MATHJAX_CODEFILE tag can be used to specify a file with JavaScript
pieces of code that will be used on startup of the MathJax code.
See
<a href="http://docs.mathjax.org/en/v2.7-latest/output.html">the MathJax site</a>
Expand Down Expand Up @@ -2804,13 +2804,13 @@ MATHJAX_CODEFILE = disableRenderer.js
<docs>
<![CDATA[
When the \c SEARCHENGINE tag is enabled doxygen will generate a search box
for the HTML output. The underlying search engine uses javascript
for the HTML output. The underlying search engine uses JavaScript
and DHTML and should work on any modern browser. Note that when using
HTML help (\ref cfg_generate_htmlhelp "GENERATE_HTMLHELP"),
Qt help (\ref cfg_generate_qhp "GENERATE_QHP"), or docsets
(\ref cfg_generate_docset "GENERATE_DOCSET") there is already a search
function so this one should typically be disabled. For large projects
the javascript based search engine can be slow, then enabling
the JavaScript based search engine can be slow, then enabling
\ref cfg_server_based_search "SERVER_BASED_SEARCH" may provide a
better solution.
Expand Down Expand Up @@ -4049,7 +4049,7 @@ to be found in the default search path.
<option type='string' id='PLANTUML_JAR_PATH' format='filedir' defval=''>
<docs>
<![CDATA[
When using plantuml, the \c PLANTUML_JAR_PATH tag should be used to specify the path where
When using PlantUML, the \c PLANTUML_JAR_PATH tag should be used to specify the path where
java can find the \c plantuml.jar file or to the filename of \c jar file to be used.
If left blank, it is assumed PlantUML is not used or
called during a preprocessing step. Doxygen will generate a warning when it encounters a
Expand All @@ -4060,16 +4060,16 @@ to be found in the default search path.
<option type='string' id='PLANTUML_CFG_FILE' format='file' defval=''>
<docs>
<![CDATA[
When using plantuml, the \c PLANTUML_CFG_FILE tag can be used to specify a configuration
file for plantuml.
When using PlantUML, the \c PLANTUML_CFG_FILE tag can be used to specify a configuration
file for PlantUML.
]]>
</docs>
</option>
<option type='list' id='PLANTUML_INCLUDE_PATH' format='dir' defval=''>
<docs>
<![CDATA[
When using plantuml, the specified paths are searched for files specified by the \c !include
statement in a plantuml block.
When using PlantUML, the specified paths are searched for files specified by the \c !include
statement in a PlantUML block.
]]>
</docs>
</option>
Expand Down

0 comments on commit 1bda21e

Please sign in to comment.