Merge pull request doxygen#11785 from artyom-fedosov/improvement/documentation

Improvement/documentation

Author: doxygen

doc/arch.dox

@@ -89,7 +89,7 @@ The preprocessed input buffer is fed to the language parser, which is
 implemented as a big state machine using \c flex. It can be found
 in the file \c src/scanner.l. There is one parser for all
 languages (C/C++/Java/IDL). The state variables \c insideIDL
-and \c insideJava are uses at some places for language specific choices.
+and \c insideJava are used at some places for language specific choices.
 
 The task of the parser is to convert the input buffer into a tree of entries
 (basically an abstract syntax tree). An entry is defined in \c src/entry.h
@@ -256,7 +256,7 @@ debug output goes by default to `stdout` unless one uses `-d stderr`.
 
 <h3>Testing</h3>
 
-Doxygen has a small set of tests available to test, some, code integrity.
+Doxygen has a small set of tests available to test code integrity.
 The tests can be run by means of the command `make tests`. When only one or a
 few tests are required one can set the variable \c TEST_FLAGS when running the
 test e.g. `make TEST_FLAGS="--id 5" tests` or for multiple tests

doc/doxywizard.1

@@ -3,11 +3,9 @@
 Doxywizard \- a tool to configure and run Doxygen on your source files
 .SH SYNOPSIS
 .B doxywizard
+.RI [Doxyfile]
 .SH DESCRIPTION
 Doxywizard is an interactive frontend to the Doxygen tool to configure
 and run Doxygen on your source files.
-.PP
-You can optionally pass the name of a configuration file as the first argument
-to load it at startup.
 .SH SEE ALSO
 doxygen(1)

doc/index.dox

@@ -34,8 +34,8 @@ Doxygen also supports the hardware description language VHDL.
 
 Doxygen can help you in three ways:
 <ol>
-<li> It can generate an on-line documentation browser (in HTML) and/or an
-     off-line reference manual (in \LaTeX) from a set
+<li> It can generate an online documentation browser (in HTML) and/or an
+     offline reference manual (in \LaTeX) from a set
      of documented source files.
      There is also support for generating output in RTF (MS-Word),
      PostScript, hyperlinked PDF, compressed HTML, and Unix man pages.
@@ -49,7 +49,7 @@ Doxygen can help you in three ways:
      by means of include dependency graphs, inheritance diagrams,
      and collaboration diagrams, which are all generated automatically.
 <li> You can also use Doxygen for creating normal documentation (as I did
-     for the Doxygen user manual and web-site).
+     for the Doxygen user manual and website).
 </ol>
 
 Doxygen is developed under macOS and Linux, but is set-up to be highly
@@ -68,7 +68,7 @@ The first part forms a user manual:
                      documentation quickly.
 <li>Section \ref docblocks demonstrates the various ways that code can
                  be documented.
-<li>Section \ref markdown show the Markdown formatting supported by Doxygen.
+<li>Section \ref markdown shows the Markdown formatting supported by Doxygen.
 <li>Section \ref lists shows how to create lists.
 <li>Section \ref grouping shows how to group things together.
 <li>Section \ref tables shows how to insert tables in the documentation.
@@ -81,10 +81,10 @@ The first part forms a user manual:
                  supported by Doxygen.
 <li>Section \ref searching shows various ways to search in the HTML documentation.
 <li>Section \ref extsearch shows how use the external search and index tools
-<li>Section \ref additional explains how you can create non-api related documentation pages.
+<li>Section \ref additional explains how you can create non-API related documentation pages.
 <li>Section \ref customize explains how you can customize the output generated
                  by Doxygen.
-<li>Section \ref custcmd show how to define and use custom commands in your comments.
+<li>Section \ref custcmd shows how to define and use custom commands in your comments.
 <li>Section \ref external explains how to let Doxygen create links to externally generated documentation.
 <li>Section \ref faq gives answers to frequently asked questions.
 <li>Section \ref trouble tells you what to do when you have problems.
@@ -104,7 +104,7 @@ The second part forms a reference manual:
               can be used within the documentation.
 <li>Section \ref xmlcmds shows an overview of the C# style XML commands that
               can be used within the documentation.
-<li>Section \ref emojisup shows an introduction how emoji can be used within
+<li>Section \ref emojisup shows an introduction to how emoji can be used within
               the documentation.
 </ul>
 
@@ -150,7 +150,7 @@ If you know other projects, let <a href="mailto:[email protected]?subject=New%20
 know and I'll add them.
 
 <h2>Future work</h2>
-Although Doxygen is successfully used by large number of companies and
+Although Doxygen is successfully used by a large number of companies and
 open source projects already, there is always room for improvement.
 <p>
 You can also submit enhancement requests in
@@ -177,7 +177,7 @@ Thanks go to:
 <li>Joerg Baumann, for adding conditional documentation blocks,
     PDF links, and the configuration generator.
 <li>Tim Mensch for adding the todo command.
-<li>Christian Hammond for redesigning the web-site.
+<li>Christian Hammond for redesigning the website.
 <li>Ken Wong for providing the HTML tree view code.
 <li>Talin for adding support for C# style comments with XML markup.
 <li>Petr Prikryl for coordinating the internationalization support.

doc/install.dox

@@ -91,7 +91,7 @@ Compilation is now done by performing the following steps:
         cmake -G "Unix Makefiles" ..
 
     <code>cmake</code> tries to determine the platform you use, and will look
-    for the requires tools. It will report if something is missing.
+    for the required tools. It will report if something is missing.
 
     If you have Qt-5.14 or higher installed and want to build the GUI
     front-end, you should enable it as follows:
@@ -190,7 +190,7 @@ These packages are needed during the compilation process.
 
 Download Doxygen's source tarball and put it somewhere (e.g. use <code>c:\\tools</code>)
 
-Now start a visual studio native command shell (for either x86 or x64) and type
+Now start a Visual Studio native command shell (for either x86 or x64) and type
 \verbatim
 cd c:\tools
 tar zxvf doxygen-x.y.z.src.tar.gz
@@ -207,7 +207,7 @@ mkdir build
 cd build
 cmake -G "Visual Studio 14 2015" ..
 \endverbatim
-This will create a project file then can be opened in Visual Studio.
+This will create a project file that can be opened in Visual Studio.
 
 If you prefer compiling from the command prompt you can use the following instead:
 \verbatim
@@ -236,7 +236,7 @@ of the GraphViz package to render nicer diagrams, see the
 If you want to produce compressed HTML files (see \ref
 cfg_generate_htmlhelp "GENERATE_HTMLHELP") in the configuration file, then
 you need the Microsoft HTML help workshop.
-In the beginning of 2021 Microsoft took the original page, with a.o. the download links,
+At the beginning of 2021, Microsoft took the original page, with a.o. the download links,
 offline the HTML help workshop was already many years in maintenance mode). 
 You can download the HTML help workshop from the web archives at
 <a href="http://web.archive.org/web/20160201063255/http://download.microsoft.com/download/0/A/9/0A939EF6-E31C-430F-A3DF-DFAE7960D564/htmlhelp.exe">Installation executable</a>.

doc/markdown.dox

@@ -655,7 +655,7 @@ stars or tildes, so the following will appear as-is:
 
 Furthermore, a `*` or `_` only starts an emphasis  and a `~` only starts a strikethrough if
 - it is followed by an alphanumerical character, and
-- it is preceded by a space, newline, or one the following characters `<{([,:;`
+- it is preceded by a space, newline, or one of the following characters `<{([,:;`
 
 An emphasis or a strikethrough ends if
 - it is not followed by an alphanumerical character, and