Docgen » History » Version 2

Chris Cannam, 2011-02-18 12:12 PM

1 1 Chris Cannam
h1. Documentation extracted from your code
2 1 Chris Cannam
3 1 Chris Cannam
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.
4 1 Chris Cannam
5 1 Chris Cannam
See the "Vamp Plugin SDK":/projects/vamp-plugin-sdk project for an example using Doxygen (look for the "Code docs" link in the navigation), or "Beatroot":/projects/beatroot for an example that uses Javadoc.
6 1 Chris Cannam
7 1 Chris Cannam
h2. How it works
8 1 Chris Cannam
9 2 Chris Cannam
Each night, a task runs which examines project repositories 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.
10 1 Chris Cannam
11 1 Chris Cannam
h2. What if I don't want this?
12 1 Chris Cannam
13 1 Chris Cannam
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)".
14 1 Chris Cannam
15 1 Chris Cannam
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.
16 2 Chris Cannam
17 2 Chris Cannam
h2. Any problems?
18 2 Chris Cannam
19 2 Chris Cannam
Just "contact us":/projects/soundsoftware-site/wiki/Help#How-to-contact-us, we're happy to try to solve any problems you might have with this.