org.weborganic.ox.dev
Class CodeDocGenerator

java.lang.Object
  org.weborganic.ox.dev.CodeDocGenerator

public final class CodeDocGenerator
extends Object

Generates the documentation from code comments in XML-based languages (XSLT, Schematron)

Version:

13 November 2013

Author:

Christophe Lauret

Constructor Summary

CodeDocGenerator(Model model)
Sole constructor.

Method Summary

File	generate(String path) Generates the documentation
Model	getModel()
static boolean	isSupported(String path) Indicates whether documentation can be generated from the code denoted by the given file path.

Methods inherited from class java.lang.Object

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

Constructor Detail

CodeDocGenerator

public CodeDocGenerator(Model model)

Sole constructor.

Parameters:

model - The model containing the code to document

Method Detail

getModel

public Model getModel()

Returns:

The model containing the code to document

generate

public File generate(String path)

Generates the documentation

Parameters:

path - The path to the code to document within the model.

isSupported

public static final boolean isSupported(String path)

Indicates whether documentation can be generated from the code denoted by the given file path.

Parameters:

path - The path within the model to the file containing the code to document.

Returns:

true is the file extension is ".xsl", ".xslt" or ".sch"; false.