Skip to content
Snippets Groups Projects
Commit 4948d84b authored by Stephan Schulz's avatar Stephan Schulz
Browse files

add libALL to doc

parent fb18d125
Branches
No related tags found
1 merge request!15CMake projectconfig
Pipeline #58118 passed
...@@ -3,7 +3,8 @@ ...@@ -3,7 +3,8 @@
Examples Examples
======== ========
In the ``/examples`` sub directory several C++ and Fortran example In the ``/examples`` sub directory several C++ and Fortran example
programs are place, as well as example projects. programs are place, as well as example projects. In some cases, where
`ALL` would be confusing, the library is referred to as `libALL`.
Projects Projects
-------- --------
......
...@@ -6,7 +6,9 @@ Usage ...@@ -6,7 +6,9 @@ Usage
The library is presented as a single load balancing object ``ALL::ALL`` The library is presented as a single load balancing object ``ALL::ALL``
from ``ALL.hpp``. All classes are encapsulated in the ``ALL`` name space. from ``ALL.hpp``. All classes are encapsulated in the ``ALL`` name space.
Simple (and not so simple) examples are available in the ``/examples`` sub Simple (and not so simple) examples are available in the ``/examples`` sub
directory. The simple examples are also documented at length. directory. The simple examples are also documented at length. In cases
where the name `ALL` is misleading, the library is referred to as
`libALL`.
Errors are treated as exceptions that are thrown of a (sub) class of Errors are treated as exceptions that are thrown of a (sub) class of
``ALL::CustomException``. Likely candidates that may throw exceptions are ``ALL::CustomException``. Likely candidates that may throw exceptions are
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment