Docgen » History » Version 1

Version 1/3 - Next ยป - Current version
Chris Cannam, 2011-02-18 12:10 PM

Documentation extracted from your code

If your project's repository contains code that is documented using either Doxygen or Javadoc, this site will automatically extract the documentation and make it available in a "Code docs" page for your project.

See the Vamp Plugin SDK project for an example using Doxygen (look for the "Code docs" link in the navigation), or Beatroot for an example that uses Javadoc.

How it works

Each night, a task runs which examines projects and checks whether they appear to contain either a Doxyfile file (the configuration file for Doxygen) or Java source code, and if either is found, extracts the documentation using Doxygen or Javadoc and makes it available for the project.

What if I don't want this?

If you have Java code or a Doxyfile in your repository but you don't want documentation to be shown for your project, just switch it off in the project settings. Go to Settings -> Modules and uncheck "Embedded documentation (Javadoc or Doxygen)".

Note that this setting is off by default, but the documentation task switches it on automatically the first time it finds your project has some documentation to extract. If you subsequently switch it off again, it will stay off.