public class BuildDocs
extends Object
This class handles the components of the user guide that should not be manually maintained.
For pages that show the help menu, this creates the page with the current help menu.
For modules, it generates a user guide page based on the ApiModule methods.
For non-ApiModule BioModules, it creates a stub.
For the BioLockJ team, this is part of the standard deploy process so that these user guide pages reflect the current code base.
For other module developers, this class be used to generate documentation for any and all modules.
For example, if you create a package joes.modules with several BioModules, you could generate the user guide pages using:
java -cp $BLJ/dist/BioLockJ.jar:path/to/your/modules.jar biolockj.api.BuildDocs docs/GENERATED joes.modules
- Author:
- Ivory Blakley