Documentation

The documentation is badly out of date, its update is a work-in-progress.

For HTML Documentation

Install Doxygen 1.8 in a way so that CMake can find it with find_package.

Enable the IRR_BUILD_DOCS CMake option, and if necessary run CMake configure again.

After running the CMake generate, there will be a docs target in your IDE or make script.

the HTML documentation will appear in the folder ./docs/htmlDocs/html/index.html in your chosen CMake build directory.

If you can't see anything of you have documented after opening index.html, it's probably because headers you were working on aren't physically in /include directory, but are somewhere in /include/irr (eg. in /include/irr/asset). CMakeLists is configured in such a way that public headers are searched in exactly /include directory. It will be changed in future.

PDF and LaTeX Documentation

The PDF documentation generation is not fixed yet, there's an issue for that (which you can resolve if you know doxygen) https://github.com/buildaworldnet/IrrlichtBAW/issues/108