Documentation extraction about sh3redux HOT 5 CLOSED

At the moment I've been using a mixture between the old Microsoft NT4 comment style, as well as Dreamworks Interactives header/comment style (Trespasser is one of the most well documented pieces of software I've ever seen), so there is not application to extract it.

Seeing as this will probably get more serious, do you recommend we switch to a more standard comment style, or should I just write a tool to extract it?

from sh3redux.

Doxygen is certainly widely used and I see little reason to take on the effort to write a competing piece of software. Doxygen also has a rather widely known style, which reduces friction for new contributors.
I'll convert one file to Doxygen-style comments later today so you can check it out.

from sh3redux.

Alright you can checkout z33ky/sh3redux@doxygen.
The Doxyfile is autogenerated by doxygen -g and merged with some old Doxyfile of another project of mine.
I've converted include/SH3/arc/types.hpp partially do Doxygen; the classes are not fully documented.
To generate HTML just execute doxygen in the project root and you can direct your browser to docs/html/index.html.

from sh3redux.

Just as a heads-up: This is being worked on. Doxygen is used now. As soon as all headers are switched to Doxygen-style I'll commit a Doxyfile and integrate it into the CMake build system.

The next step then is to move the .cpp documentation to the headers and finally ensure that all relevant things are documented.
Doxygen can warn about undocumented stuff, but this cannot be fine tuned so we will have to document every function and every member then. Not necessarily the worst option, but debatable.

from sh3redux.

It would seem that this has been taken care of.

from sh3redux.