In the Shadow of Leaves

Yesterday I added a Doxygen configuration to the Caliburn project. The intention was to make it easier to generate or update project documentation. Please notice that output formats are set to html and compiled help (chm).

Let me introduce the Doxygen ,If you haven’t used it before. Doxygen is a well known and de facto standard documentation tool for open source projects. It has many amazing features, for example:

• It requires very little overhead from the writer of the documentation. Plain text will do, but for more fancy or structured output HTML tags and/or some of doxygen’s special commands can be used.
• It supports C/C++, Java, (Corba and Microsoft) Java, Python, IDL, C#, Objective-C and to some extent D and PHP sources.
• Supports documenting of files, namespaces, packages, classes, structs, unions, templates, variables, functions, typedefs, enums and defines.
• Automatically generates class and collaboration diagrams in HTML (as clickable image maps) and LaTeX (as Encapsulated PostScript images).
• Uses the dot tool of the Graphviz tool kit to generate include dependency graphs, collaboration diagrams, call graphs, directory structure graphs, and graphical class hierarchy graphs.
• Generates a list of all members of a class (including any inherited members) along with their protection level.
• References to base/super classes and inherited/overridden members are generated automatically.
• Includes a fast, rank based search engine to search for strings or words in the class and member documentation.
• Allows automatic cross-referencing of (documented) entities with their definition in the source code.
• All source code fragments are syntax highlighted for ease of reading.
• Can cope with large projects easily.

You can download this free and open source software from doxygen.org site.

On the image below you can see a small snippet from class diagram.

The next image shows a graphic display of the project directories tree.

Here you can see the highlighted syntax and cross referenced code.

On the last image you can see the call graph for one of the methods

I hope that this configuration will make it easier to understand and start using the Caliburn framework.