Documentation

Crafter 2D uses the DoxyGen tool to generate source code documentation. Using this documentation you can easily find classes and diagrams on how to use them. Doxygen supports several types of output including HTML, compiled help, man pages and Latex. The later versions can also generate search functionality making it even easier to find what you are looking for.

There are already a lot of pages, including the official website, that explain how to write Doxygen compatible documentation thus you will not find it in this document. Here you will only find how to generate the documentation for JEngine SSE.

''Note: the writting of documentation is an ongoing process, which currently does not have the highest priority. But it still remains on the list and being worked at, hence this page!''

Generating

If you have not installed Doxygen on your computer, you should do that first. It has pre-compiled binaries for most operating systems. I recommend also to use the open source Graphvis package, which is used by Doxygen to generate the diagrams.

The setup does no longer come with pre-compiled documentation as the file becomes quite large when diagrams are used. Generating your own documentation is very easy. The root folder of the engine contains the Doxygen configuration file. I have configured it to create HTML pages only as output. There are still many configuration options you can change. I use the Doxywizard application to do the configuration.

In case you installed the Graphviz package, you have to set up the '''dot''' properties and point to the installation directory.

HTML help

In order to generate the HTML help file you need the latest Microsoft HTML Help Workshop software which can be downloaded from the Microsoft website for free. You will also need to change some of the properties in Doxywizard:

• Enable GENERATE_HTMLHELP
• Set HHC_LOCATION to the path (including hhc.exe) where the workshop is installed.

Note: I noticed that when creating the HTML help file, the search functionality in the normal HTML website is not created.

References

[http://www.stack.nl/~dimitri/doxygen/index.html Offical website DoxyGen]

[http://graphviz.org/ Graphviz offical website]