Add C++ docs for recipe (#461)
Add some C++ API documentation. * Create C++ API section in docs. * Document `arb::recipe`: both a class reference along with more explanatory text and best practices guide. * Add some class documentation of basic types required to understand recipe definition. * Some in-code comment clean up. * Change `arb::cell_kind` from a vanilla enum to a scoped enum.
Showing
- doc/cpp_common.rst 115 additions, 0 deletionsdoc/cpp_common.rst
- doc/cpp_intro.rst 11 additions, 0 deletionsdoc/cpp_intro.rst
- doc/cpp_recipe.rst 230 additions, 0 deletionsdoc/cpp_recipe.rst
- doc/index.rst 8 additions, 4 deletionsdoc/index.rst
- doc/install.rst 2 additions, 1 deletiondoc/install.rst
- example/miniapp/miniapp.cpp 1 addition, 1 deletionexample/miniapp/miniapp.cpp
- src/common_types.hpp 1 addition, 1 deletionsrc/common_types.hpp
- src/fvm_multicell.hpp 1 addition, 1 deletionsrc/fvm_multicell.hpp
- src/partition_load_balance.cpp 3 additions, 2 deletionssrc/partition_load_balance.cpp
- src/recipe.hpp 5 additions, 5 deletionssrc/recipe.hpp
- src/util/enumhash.hpp 20 additions, 0 deletionssrc/util/enumhash.hpp
- tests/simple_recipes.hpp 1 addition, 1 deletiontests/simple_recipes.hpp
Please register or sign in to comment