sigveka
commented
8 years ago Yes that is because I removed initModels. I was not sure about that one... maybe I should just put it back...
What do you think about having "twoTanks.py" in the directory. Should we consider to add that to "models" as well?
Sigve
On 2 October 2015 at 14:32, Henrik Rusche notifications@github.com wrote:
Dear MoDeNa programmers,
I've set-up doxygen for the MoDeNa software. From http://www.stack.nl/~dimitri/doxygen/
Doxygen is the de facto standard tool for generating documentation from annotated C++ sources, but it also supports other popular programming languages such as C, Objective-C, C#, PHP, Java, Python, IDL (Corba, Microsoft, and UNO/OpenOffice flavors), Fortran, VHDL, Tcl, and to some extent D.
The current output for the nextRelease branch can be inspected here:
http://henrus.github.io/MoDeNa/index.html
As you can see there are a few glitches, but it starts to make sense. In particular:
In order for you to get started, please read the documentation on "Documenting the code", "Markdown support", "Including Formulas"
http://www.stack.nl/~dimitri/doxygen/manual/docblocks.html http://www.stack.nl/~dimitri/doxygen/manual/markdown.html http://www.stack.nl/~dimitri/doxygen/manual/formulas.html
What do you need to do next:
- All headers need to be changed (see examples/twoTank, applications/PUfoamRheology/rheology.py)
- Make sure that the @ingroup https://github.com/ingroup heads to the correct example/application
- Add in-code documentation for important functions and files. In particular, all model modules. For the moment, just add documentation below @file https://github.com/file and for the FireTask.
- Add @brief https://github.com/brief to the README.md files
To see the results of your changes:
user@machine> sudo apt-get install doxygen doxypy user@machine> doxygen doc/Doxyfile
Then point your browser to html/index.html.
Please have a go at this asap. I will also post this on github.
Best Regards,
Henrik
— Reply to this email directly or view it on GitHub https://github.com/MoDeNa-EUProject/MoDeNa/issues/30.
henrus
Dear MoDeNa programmers,
I've set-up doxygen for the MoDeNa software. From http://www.stack.nl/~dimitri/doxygen/
Doxygen is the de facto standard tool for generating documentation from annotated C++ sources, but it also supports other popular programming languages such as C, Objective-C, C#, PHP, Java, Python, IDL (Corba, Microsoft, and UNO/OpenOffice flavors), Fortran, VHDL, Tcl, and to some extent D.
The current output for the nextRelease branch can be inspected here:
http://henrus.github.io/MoDeNa/index.html
As you can see there are a few glitches, but it starts to make sense. In particular:
In order for you to get started, please read the documentation on "Documenting the code", "Markdown support", "Including Formulas"
http://www.stack.nl/~dimitri/doxygen/manual/docblocks.html http://www.stack.nl/~dimitri/doxygen/manual/markdown.html http://www.stack.nl/~dimitri/doxygen/manual/formulas.html
What do you need to do next:
To see the results of your changes:
user@machine> sudo apt-get install doxygen doxypy user@machine> doxygen doc/Doxyfile
Then point your browser to html/index.html.
Please have a go at this asap. I will also post this on github.
Best Regards,
Henrik