biolockj.api

Class BuildDocs

java.lang.Object

biolockj.api.BuildDocs

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

Constructor Summary

Constructors

Constructor and Description
BuildDocs()

Method Summary

Modifier and Type	Method and Description
static String	copyFromFile(File file)
static String	copyFromModuleResource(BioModule module, String name)
static void	main(String[] args) For standard use case, pass in $BLJ/mkdocs/user-guide/docs/GENERATED

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BuildDocs

public BuildDocs()

Method Detail

main

public static void main(String[] args)
                 throws Exception

For standard use case, pass in $BLJ/mkdocs/user-guide/docs/GENERATED

Parameters:

args - first art is baseDir - the folder where the output should be saved. If a second arg, it should be the package root for generating the documentation for a third-party package.

Throws:

Exception

copyFromModuleResource

public static String copyFromModuleResource(BioModule module,
                                            String name)
                                     throws API_Exception

Throws:

API_Exception

copyFromFile

public static String copyFromFile(File file)
                           throws API_Exception,
                                  FileNotFoundException

Throws:

API_Exception

FileNotFoundException