Skip to content

Commit

Permalink
Deploying to gh-pages from @ 1cccf13 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
colinkiama committed Nov 3, 2024
1 parent 95c754e commit 5d072a6
Show file tree
Hide file tree
Showing 20 changed files with 25 additions and 25 deletions.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified .doctrees/environment.pickle
Binary file not shown.
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ Generate the documentation for the by running the following command:
However, be aware that ``--force`` does not remove any documentation. It only adds and overwrites documentation.

This will generate a the documentation of the code in the ``docs`` directory.
This will generate the documentation of the code in the ``docs`` directory.

Open ``docs/index.html`` in a web browser to view the generated documentation:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Essential Options
**-o,--directory=DIRECTORY**
Output directory of the generated documentation.

The name ofthe directory will also be used as the package name if a package name has not been explicitly
The name of the directory will also be used as the package name if a package name has not been explicitly
set and cannot be derived from any other sources

**--package-name=NAME**
Expand All @@ -28,16 +28,16 @@ Essential Options
Sets the package version of the generated documentation.

**--force**
Force the doumentation to be generated, even if the output directory already exists.
Force the documentation to be generated, even if the output directory already exists.

As stated in the :doc:`quick start guide </developer-guides/documentation/valadoc-guide/01-00-quick-start>`,
with this option set, generated documentation is only addd or overwritten.
with this option set, generated documentation is only added or overwritten.

**--pkg=PAKAGE...**
Speify bindings to inlude in th documentation via their package names.
**--pkg=PACKAGE...**
Specify bindings to include in the documentation via their package names.

**--version**
Display the vesrion number of the valadoc tool.
Display the version number of the valadoc tool.

**-h, --help**
View the list of all of the commands and options that ``valadoc`` supports.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Documentation Comment Structure
.. note::

When no comments are present, Valadoc will only extact symbols to use in the documentation.
When no comments are present, Valadoc will only extract symbols to use in the documentation.

In this chapter, we'll explain how to fill each section of a documentation comment.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Brief Description
=================

The brief description is used thoughout the entire documentation as a short summary for the symbol you're documenting.
The brief description is used throughout the entire documentation as a short summary for the symbol you're documenting.

Example
-------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Inline Taglets
Inline Taglets are used in descriptions.

**{@inheritDoc}**
Used to diectly inherit descriptions from the parent symbol
Used to directly inherit descriptions from the parent symbol

**{@link [node]}**
Used to link to another symbol. ``[node]`` is the fully qualified name of the
Expand Down Expand Up @@ -45,4 +45,4 @@ Block taglets are used at the end of each documentation comment.
Add description of result of data returned from a symbol.

**@throws [type-name] [description]**
Specify an eror that could get thrown through the usage of a symbol
Specify an error that could get thrown through the usage of a symbol
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,6 @@ merge requests are appreciated!
Valadoc.org (API References Website)
------------------------------------

`<https://valadoc.org>`_, is generated by combining documentation generated by valadoc fom various sources.
`<https://valadoc.org>`_, is generated by combining documentation generated by valadoc from various sources.
You can learn more about how this process works and how you can help contribute to the project in
its `git repository <https://github.com/vala-lang/valadoc-org>`_.
its `git repository <https://github.com/vala-lang/valadoc-org>`_.
Original file line number Diff line number Diff line change
Expand Up @@ -515,7 +515,7 @@ <h2><span class="section-number">1.1. </span>Basic Usage<a class="headerlink" hr
</div>
<p>However, be aware that <code class="docutils literal notranslate"><span class="pre">--force</span></code> does not remove any documentation. It only adds and overwrites documentation.</p>
</div>
<p>This will generate a the documentation of the code in the <code class="docutils literal notranslate"><span class="pre">docs</span></code> directory.</p>
<p>This will generate the documentation of the code in the <code class="docutils literal notranslate"><span class="pre">docs</span></code> directory.</p>
<p>Open <code class="docutils literal notranslate"><span class="pre">docs/index.html</span></code> in a web browser to view the generated documentation:</p>
<img alt="Simon Says Documentation Home" src="../../../_images/simon-says-home.png" />
<p>Select the “simon-says” package to view its contents:</p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -483,20 +483,20 @@ <h1><span class="section-number">2. </span>Command Line Tool<a class="headerlink
<h2><span class="section-number">2.1. </span>Essential Options<a class="headerlink" href="#essential-options" title="Permalink to this heading"></a></h2>
<dl>
<dt><strong>-o,–directory=DIRECTORY</strong></dt><dd><p>Output directory of the generated documentation.</p>
<p>The name ofthe directory will also be used as the package name if a package name has not been explicitly
<p>The name of the directory will also be used as the package name if a package name has not been explicitly
set and cannot be derived from any other sources</p>
</dd>
<dt><strong>–package-name=NAME</strong></dt><dd><p>Sets the name of the package of the generated documentation.</p>
</dd>
<dt><strong>–package-version=VERSION</strong></dt><dd><p>Sets the package version of the generated documentation.</p>
</dd>
<dt><strong>–force</strong></dt><dd><p>Force the doumentation to be generated, even if the output directory already exists.</p>
<dt><strong>–force</strong></dt><dd><p>Force the documentation to be generated, even if the output directory already exists.</p>
<p>As stated in the <a class="reference internal" href="01-00-quick-start.html"><span class="doc">quick start guide</span></a>,
with this option set, generated documentation is only addd or overwritten.</p>
with this option set, generated documentation is only added or overwritten.</p>
</dd>
<dt><strong>–pkg=PAKAGE</strong></dt><dd><p>Speify bindings to inlude in th documentation via their package names.</p>
<dt><strong>–pkg=PACKAGE</strong></dt><dd><p>Specify bindings to include in the documentation via their package names.</p>
</dd>
<dt><strong>–version</strong></dt><dd><p>Display the vesrion number of the valadoc tool.</p>
<dt><strong>–version</strong></dt><dd><p>Display the version number of the valadoc tool.</p>
</dd>
<dt><strong>-h, –help</strong></dt><dd><p>View the list of all of the commands and options that <code class="docutils literal notranslate"><span class="pre">valadoc</span></code> supports.</p>
<p>You’ll see additional options that aren’t listed on this page when you use this option.</p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -483,7 +483,7 @@ <h2><span class="section-number">3.1. </span>Documentation Comment Structure<a c
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>When no comments are present, Valadoc will only extact symbols to use in the documentation.</p>
<p>When no comments are present, Valadoc will only extract symbols to use in the documentation.</p>
</div>
<p>In this chapter, we’ll explain how to fill each section of a documentation comment.</p>
<div class="toctree-wrapper compound">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -470,7 +470,7 @@
<article role="main" id="furo-main-content">
<section id="brief-description">
<h1><span class="section-number">3.1.1. </span>Brief Description<a class="headerlink" href="#brief-description" title="Permalink to this heading"></a></h1>
<p>The brief description is used thoughout the entire documentation as a short summary for the symbol you’re documenting.</p>
<p>The brief description is used throughout the entire documentation as a short summary for the symbol you’re documenting.</p>
<section id="example">
<h2><span class="section-number">3.1.1.1. </span>Example<a class="headerlink" href="#example" title="Permalink to this heading"></a></h2>
<div class="highlight-vala notranslate"><div class="highlight"><pre><span></span><span class="cm">/**</span>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -481,7 +481,7 @@ <h1><span class="section-number">3.1.3. </span>Taglets<a class="headerlink" href
<h2><span class="section-number">3.1.3.1. </span>Inline Taglets<a class="headerlink" href="#inline-taglets" title="Permalink to this heading"></a></h2>
<p>Inline Taglets are used in descriptions.</p>
<dl class="simple">
<dt><strong>{&#64;inheritDoc}</strong></dt><dd><p>Used to diectly inherit descriptions from the parent symbol</p>
<dt><strong>{&#64;inheritDoc}</strong></dt><dd><p>Used to directly inherit descriptions from the parent symbol</p>
</dd>
<dt><strong>{&#64;link [node]}</strong></dt><dd><p>Used to link to another symbol. <code class="docutils literal notranslate"><span class="pre">[node]</span></code> is the fully qualified name of the
symbol you want to link to. e.g. <code class="docutils literal notranslate"><span class="pre">{&#64;link</span> <span class="pre">GLib.Action}</span></code>.</p>
Expand All @@ -505,7 +505,7 @@ <h2><span class="section-number">3.1.3.2. </span>Block Taglets<a class="headerli
</dd>
<dt><strong>&#64;return [description]</strong></dt><dd><p>Add description of result of data returned from a symbol.</p>
</dd>
<dt><strong>&#64;throws [type-name] [description]</strong></dt><dd><p>Specify an eror that could get thrown through the usage of a symbol</p>
<dt><strong>&#64;throws [type-name] [description]</strong></dt><dd><p>Specify an error that could get thrown through the usage of a symbol</p>
</dd>
</dl>
</section>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -484,7 +484,7 @@ <h2><span class="section-number">3.1.4.2. </span>Valadoc Command Line Tool<a cla
</section>
<section id="valadoc-org-api-references-website">
<h2><span class="section-number">3.1.4.3. </span>Valadoc.org (API References Website)<a class="headerlink" href="#valadoc-org-api-references-website" title="Permalink to this heading"></a></h2>
<p><a class="reference external" href="https://valadoc.org">https://valadoc.org</a>, is generated by combining documentation generated by valadoc fom various sources.
<p><a class="reference external" href="https://valadoc.org">https://valadoc.org</a>, is generated by combining documentation generated by valadoc from various sources.
You can learn more about how this process works and how you can help contribute to the project in
its <a class="reference external" href="https://github.com/vala-lang/valadoc-org">git repository</a>.</p>
</section>
Expand Down
2 changes: 1 addition & 1 deletion searchindex.js

Large diffs are not rendered by default.

0 comments on commit 5d072a6

Please sign in to comment.