![]() |
Elm
2
ELM is a library providing generic data structures, OS-independent interface, plugins and XML.
|
Directories:
Bootstrap: cmake .
Under Windows (MINGW required): cmake . -G "MSYS Makefiles"
Auto-documentation: doxygen xdg-open autodoc/index.html
Activating the test compilation: cmake . -DWITH_TEST=yes
Testing: cd test ./dotest launch all automated tests ./test-thread thread classes
Under Windows: move src/libelm.dll to test/
All classes, function, macros, variable or type provided to uses must be documented using the Doxygen tool. Doxygen automatic documentation is very close to JavaDoc but provides more flexibility and support for C++. The syntax detail can be found here.
Additionally, Doxygen supports Markdown wiki syntax that may be found here. Below is a non-exhaustive list of markdown syntax:
to avoid c to be used as special charactertext for code textAn important rule must be applied: no documentation must be put in the header file. Classes has to be described in the source file. For a class, a special comment like below must be set: /**