Fix typos (#201)

docs/mastering_doxygen.rst

@@ -292,7 +292,7 @@ documenting specific aspects:
 +-----------------+--------------------------------------------------------------------+
 | ``\return``     | Add documentation for the return value.                            |
 +-----------------+--------------------------------------------------------------------+
-| Explicit Control Over Contstructs (e.g., Adding Documentation Apart from Definition )|
+| Explicit Control Over Constructs (e.g., Adding Documentation Apart from Definition ) |
 +-----------------+--------------------------------------------------------------------+
 | ``\struct``     | To document a ``struct``.                                          |
 +-----------------+--------------------------------------------------------------------+

docs/overview.rst

@@ -47,7 +47,7 @@ build is producing warnings, this is why Exhale is not creating what you expect.
 
    Doxygen is a complex and advanced tool!  In particular, you will likely need to
    finesse the Doxygen preprocessor for everything to work out as expected.  Refer to
-   the :ref:`doxygen_documentaion_specifics` section for more information.
+   the :ref:`doxygen_documentation_specifics` section for more information.
 
 From there, Exhale needs the following information, all provided in ``conf.py``:
 

docs/quickstart.rst

@@ -69,13 +69,13 @@ but it is not overwhelmingly significant.
 
 The main thing to understand is that where Exhale is concerned, **all relative paths
 specified in any configuration variables are relative to wherever** ``conf.py``
-**lives**.  The ``build artfiacts go here`` section is to just explain that if you do
+**lives**.  The ``build artifacts go here`` section is to just explain that if you do
 ``make html``, then in the ``n`` case a folder ``docs/_build/html`` will be created, and
 in the ``y`` case it will be in ``docs/build/html``.  Repeat for ``make linkcheck``.
 In either case, you will definitely want to add ``docs/_build`` or ``docs/build`` to
 your ``.gitignore`` or related version control ignore file.
 
-The only other thing worth pointing out here is that by default sphinx reates the
+The only other thing worth pointing out here is that by default sphinx creates the
 ``_static`` and ``_templates`` directories for you.  At first start, you don't use those
 but:
 

docs/reference/configs.rst

@@ -476,7 +476,7 @@ something like this, where special treatment is given to File pages specifically
         set :data:`~exhale.configs.generateBreatheFileDirectives` to ``True`` **as a
         debugging feature**.
 
-        Please refer to the :ref:`doxygen_documentaion_specifics` section for potential
+        Please refer to the :ref:`doxygen_documentation_specifics` section for potential
         causes, in particular the subsection describing
         :ref:`file_and_namespace_level_documentation_in_exhale`.
 
@@ -647,7 +647,7 @@ possible inputs and outputs in a dictionary.  Details aside, it's easier than it
 
    .. code-block:: py
 
-      # somewhere in `conf.py`, *BERORE* declaring `exhale_args`
+      # somewhere in `conf.py`, *BEFORE* declaring `exhale_args`
       def specificationsForKind(kind):
           '''
           For a given input ``kind``, return the list of reStructuredText specifications

docs/testing.rst

@@ -33,7 +33,7 @@ list is defined as:
    [testenv]
    envlist = py, flake8
 
-This means that the version of python the tests are run with are the interpretor that
+This means that the version of python the tests are run with are the interpreter that
 you installed ``tox`` for.  To run a specific test:
 
 ``tox -e py``

docs/usage.rst

@@ -6,7 +6,7 @@ how familiar you are with things like Sphinx, Breathe, Doxygen, etc.  At the top
 what you need is:
 
 1. Your C++ code you want to document, with "proper" Doxygen documentation.  Please
-   read the :ref:`doxygen_documentaion_specifics` for common documentation pitfalls,
+   read the :ref:`doxygen_documentation_specifics` for common documentation pitfalls,
    as well as features previously unavailable in standard Doxygen.
 2. A sphinx documentation project ready to go.  See the
    `Sphinx Getting Started <https://www.sphinx-doc.org/en/master/usage/quickstart.html>`_
@@ -348,7 +348,7 @@ Executing Doxygen Independently
 This is another option, just make sure that Doxygen is run **before** Exhale is.  See
 the note at the bottom of the :ref:`quickstart_guide`.
 
-.. _doxygen_documentaion_specifics:
+.. _doxygen_documentation_specifics:
 
 Doxygen Documentation Specifics
 ----------------------------------------------------------------------------------------

exhale/configs.py

@@ -468,7 +468,7 @@ class and file hierarchies.
 **Value in** ``exhale_args`` (list or set of strings)
     The list of kinds (see :data:`~exhale.utils.AVAILABLE_KINDS`) that will **not** be
     included in the unabridged API listing.  The default is to exclude pages (which are
-    already in the page hierarhcy), directories and files (which are already in the file
+    already in the page hierarchy), directories and files (which are already in the file
     hierarchy).  Note that if this variable is provided, it will overwrite the default
     ``{"dir", "file", "page"}``, meaning if you want to exclude something in addition
     you need to include ``"page"``,  ``"dir"``, and ``"file"``:

exhale/deploy.py

@@ -235,7 +235,7 @@ def generateDoxygenXML():
 
                       {default}
 
-                - The output path specfied (`breathe_projects[breathe_default_project]`):
+                - The output path specified (`breathe_projects[breathe_default_project]`):
 
                       {path}
 

exhale/graph.py

@@ -226,7 +226,7 @@ def __lt__(self, other):
                     return False
 
                 # NOTE: kind of wasteful, but ordered_refs has ALL pages
-                # but realistically, there wont be *that* many pages. right? ;)
+                # but realistically, there won't be *that* many pages. right? ;)
                 ordered_refs = [
                     p.refid for p in self.root_owner.index_xml_page_ordering
                 ]
@@ -1042,7 +1042,7 @@ class ExhaleRoot(object):
             The full list of ExhaleNodes of kind ``file``.
 
         ``groups`` (list)
-            The full list of ExhaleNodes of kind ``group``.  Pupulated, not used.
+            The full list of ExhaleNodes of kind ``group``.  Populated, not used.
 
         ``namespaces`` (list)
             The full list of ExhaleNodes of kind ``namespace``.
@@ -2352,7 +2352,7 @@ def generateNodeDocuments(self):
         resulting list then has all of ``self.class_like``, as well as any nested
         classes and structs found.  With ``enum`` and ``union``, these would have been
         reparented to a **class** or **struct** if it was removed from the relevant
-        ``self.<breathe_kind>`` list.  Meaning we must make sure that we genererate the
+        ``self.<breathe_kind>`` list.  Meaning we must make sure that we generate the
         single node RST documents for everything by finding the nested enums and unions
         from ``self.class_like``, as well as everything in ``self.enums`` and
         ``self.unions``.
@@ -2514,7 +2514,7 @@ class view hierarchy (<a href="..."> for the ``createTreeView = True`` option).
                     child=title
                 )
 
-        # `unique_id` and `title` should be set approriately for all nodes by this point
+        # `unique_id` and `title` should be set appropriately for all nodes by this point
         if node.kind in SPECIAL_CASES:
             node.link_name = "{kind}_{id}".format(kind=node.kind, id=unique_id)
             node.file_name = "{link_name}.rst".format(link_name=node.link_name)
@@ -3775,7 +3775,7 @@ def generateViewHierarchies(self):
         :func:`~exhale.graph.ExhaleRoot.generatePageView`,
         :func:`~exhale.graph.ExhaleRoot.generateClassView`, and
         :func:`~exhale.graph.ExhaleRoot.generateDirectoryView` --- if you want to implement
-        additional hierarchies, implement the additionaly hierarchy method and call it
+        additional hierarchies, implement the additionally hierarchy method and call it
         from here.  Then make sure to ``include`` it in
         :func:`~exhale.graph.ExhaleRoot.generateAPIRootBody`.
         '''
@@ -3815,12 +3815,12 @@ def writeOutHierarchy(self, hierarchy_config, data):
             # 1. The interior of an HTML <ul> ... </ul> (collapsible lists)
             # 2. A json array for returning from a javascript function (bootstrap)
             #
-            # In either case, the data is currently well-formatted, no "suprise"
+            # In either case, the data is currently well-formatted, no "surprise"
             # newlines should appear, etc.  So we can just split the lines and strip
             # the leading indentation.
             if configs.minifyTreeView:
                 data = "".join([line.strip() for line in data.splitlines()])
-                # For the bootstrap version we can also further elminate some extra
+                # For the bootstrap version we can also further eliminate some extra
                 # spaces between colons and their mapped value, and delete some
                 # erroneous commas that don't hurt but don't help ;)
                 if configs.treeViewIsBootstrap:
@@ -4022,7 +4022,7 @@ class view hierarchy.  It will be present in the file page it was declared in
 
         2. The configurations of Doxygen.  For example, see the warning in
            :func:`~exhale.graph.ExhaleRoot.fileRefDiscovery`.  Items whose parents cannot
-           be rediscovered withouth the programlisting will still be documented, their
+           be rediscovered without the programlisting will still be documented, their
            link appearing in the unabridged API listing.
 
         Currently, the API is generated in the following (somewhat arbitrary) order:

exhale/utils.py

@@ -352,7 +352,7 @@ def sanitize_all(names):
 
 .. note::
 
-   Feel free to make a pull request adding more lanugages here.  For example, the
+   Feel free to make a pull request adding more languages here.  For example, the
    ``Verilog`` support comes from
    `doxygen-verilog <https://github.com/avelure/doxygen-verilog>`_.
 '''
@@ -913,7 +913,7 @@ def tokenize(s: str):
             # up the KEEP clauses.
             if mo.lastgroup == "COMMA":
                 continue
-            # If the result of trimming whitespace is the emptry string, then this is
+            # If the result of trimming whitespace is the empty string, then this is
             # not a novel template parameter and should be skipped.  We normalize the
             # remainder of the name so that e.g., foo< int > gives just ["foo", ["int"]]
             # rather than having funky whitespace everywhere.

testing/hierarchies.py

@@ -164,7 +164,7 @@ class define(node):  # noqa: N801
     **Parameters**
 
         ``name`` (:class:`python:str`)
-            The name of the define / macro being representated
+            The name of the define / macro being represented
 
     .. todo:: Do macros (with parameters) need special treatment?
     """

testing/projects/cpp_pimpl/include/pimpl/jupiter.hpp

@@ -54,7 +54,7 @@ namespace pimpl {
         class JupiterImpl;
     }
 
-    /// A class that represnts the planet Jupiter (version 2).
+    /// A class that represents the planet Jupiter (version 2).
     class Jupiter_v2 : public Planet {
     public:
         Jupiter_v2();                       ///< Constructs an Jupiter_v2.

testing/tests/configs.py

@@ -314,7 +314,7 @@ def total(self, root):
 
     @confoverrides(exhale_args={"unabridgedOrphanKinds": []})
     def test_no_exclusion(self):
-        """Verify empty list means no exlusions from full API."""
+        """Verify empty list means no exclusions from full API."""
         full_names, orphan_names = self.checkAllFilesIncluded()
         root = get_exhale_root(self)
         total = self.total(root)

testing/tests/cpp_pimpl.py

@@ -200,7 +200,7 @@ def link_name_format_dict(self):
 
     def expected_class_hierarchy(self, exclusions):
         """
-        Return expected rst class hiearchy listing based on specified ``exclusions``.
+        Return expected rst class hierarchy listing based on specified ``exclusions``.
 
         Helper method for :func:`validate_class_hierarchy`.