Skip to content

Commit 067862f

Browse files
committed
docs: add page that contains the API docs of the Error package
1 parent ecf3718 commit 067862f

File tree

2 files changed

+23
-0
lines changed

2 files changed

+23
-0
lines changed

docs/error/index.rst

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
Error Package
2+
=============
3+
4+
A C++ package that provides utilities for error handling.
5+
6+
.. doxygenfunction:: error::make
7+
8+
.. doxygenfunction:: error::format
9+
10+
.. doxygenstruct:: error::Error
11+
:members:
12+
13+
.. doxygenfunction:: error::operator==
14+
15+
.. doxygenfunction:: error::operator!=

docs/index.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,11 @@ A comprehensive collection of `C++`_ utility packages.
99
.. _build_status_badge: https://github.com/threeal/cpp/actions/workflows/build.yml
1010

1111
.. _C++: https://isocpp.org
12+
13+
Packages
14+
--------
15+
16+
.. toctree::
17+
:maxdepth: 1
18+
19+
error/index.rst

0 commit comments

Comments
 (0)