Skip to content

Commit

Permalink
Fix some typos in valadoc-guide (#53)
Browse files Browse the repository at this point in the history
  • Loading branch information
vpzomtrrfrt authored Nov 3, 2024
1 parent 7d3d55b commit 1cccf13
Show file tree
Hide file tree
Showing 6 changed files with 13 additions and 13 deletions.
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>`_.

0 comments on commit 1cccf13

Please sign in to comment.