Skip to content

Commit 18deeb7

Browse files
committed
docu: adding docu modules
- Controllers - Internals - Utilities - Examples
1 parent 3022436 commit 18deeb7

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

include/pfasst.hpp

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,4 +23,21 @@ namespace pfasst
2323
}
2424
} // ::pfasst
2525

26+
27+
/**
28+
* @defgroup Controllers
29+
* Controllers represent the main entry point of PFASST++ as they ensemble the central algorithmic
30+
* logic of PFASST and related algorithms.
31+
*
32+
* @defgroup Internals
33+
* Entities listed in this module are ment to be for internal use only and should not be used
34+
* outside of PFASST++ itself.
35+
*
36+
* @defgroup Utilities
37+
* General utility functions not directly related to PFASST++ but also handy in user code.
38+
*
39+
* @defgroup Examples
40+
* A few different examples demonstrating the use and functionality of PFASST++.
41+
*/
42+
2643
#endif

0 commit comments

Comments
 (0)