Package ortus.boxlang.tools.util

Class BIFDocumentationGenerator

java.lang.Object

ortus.boxlang.tools.util.BIFDocumentationGenerator

public class BIFDocumentationGenerator
extends Object

Constructor Summary

Constructors

Constructor	Description
BIFDocumentationGenerator()

Method Summary

Modifier and Type	Method	Description
static IStruct	generate(DocletEnvironment docsEnvironment)
static HashMap<String,String>	generateBIFTemplate(IStruct bifRecord, List<Element> docElements, DocletEnvironment docsEnvironment)	Generates the physical BIF Documentation template and writes it out to the disk

Methods inherited from class java.lang.Object

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

Constructor Details

BIFDocumentationGenerator

public BIFDocumentationGenerator()

Method Details

generate

public static IStruct generate(DocletEnvironment docsEnvironment)
                        throws IOException

Throws:

IOException

generateBIFTemplate

public static HashMap<String,String> generateBIFTemplate(IStruct bifRecord,
 List<Element> docElements,
 DocletEnvironment docsEnvironment)

Generates the physical BIF Documentation template and writes it out to the disk

Parameters:

bifRecord - The struct containing the BIF information

docElements - The list of all Javadoc elements for the BIF class

docsEnvironment - The full docs environment, which allows us to access the util methods

Returns: