extend doxygen support

This commit is contained in:
James McClure
2021-09-18 16:33:26 -04:00
parent 6eb19ad764
commit daba5c7521
7 changed files with 85 additions and 5 deletions

View File

@@ -1,12 +1,17 @@
/** \mainpage LBPM
*
* This is the documentation for LBPM
* C/C++ routines
*
* - \ref IO "IO routines"
* - \ref analysis "Analysis routines"
* - \ref FlowAdaptor "Flow adaptor"
* - \ref FlowAdaptor "FlowAdaptor"
* - \ref DCEL "Doubly connected edge list"
* - \ref Minkowski "Minkowski functionals"
* - \ref models "Lattice Boltzmann models"
* - \ref ScaLBL "Lattice Boltzmann building blocks"
* - \ref ScaLBL "Scalable Lattice Boltzmann Library (ScaLBL)"
* - \ref cpu "cpu implementation for library routines"
* - \ref cuda "CUDA implementation for library routines"
* - \ref hip "HIP implementation for library routines"
* - \ref tests "Unit tests"
* - \ref Utilities "Utility routines"
*