Developers wiki: Developers tools

Developers tools

Doxygen documentation

The Doxygen documentation related to the last release is available on the github pages related to the MmgTools oraganization: https://mmgtools.github.io/

To build locally the Mmg documentation:

1. We assume that you have Doxygen installed.

2. Inside your build directory, run the make doc command to compile the project documentation;

3. The developers documentation is now available under the doc folder of your build directory, you just have to open the doc/index.html file to see it.

Continuous integration tests

Basic use

You can test your mmg's applications by enabling and running the continuous integration tests (we suggest you to run the tests in debug mode, see the Configuration section of the setup guide for more informations on the compilation modes):

cmake -D CMAKE_BUILD_TYPE=Debug -D BUILD_TESTING=ON ..
make
ctest

Advanced use

You can enable or disable some tests using the following CMake's variables:

| Variable name | Object | Authorized values and effects | |----------------------|-----------------------------------|-------------------------|----------------| | MMG2D_CI | enable or disable the mmg2d tests |

ON	enabled
OFF	disabled

| | MMG3D_CI | enable or disable the mmg3d tests |

ON	enabled
OFF	disabled

| | MMGS_CI | enable or disable the mmgs tests |

ON	enabled
OFF	disabled

| | TEST_LIBMMG3D | enable or disable the tests for the mmg3d library |

ON	enabled
OFF	disabled

| | TEST_LIBMMG2D | enable or disable the tests for the mmg2d library |

ON	enabled
OFF	disabled

| | TEST_LIBMMGS | enable or disable the tests for the mmgs library |

ON	enabled
OFF	disabled

|

Example:
The following command configure CTest to run only the mmg3d application and library tests:

cmake -D TEST_LIBMMG3D=ON ..