org.codehaus.cargo.documentation

Class ConfluenceProjectStructureDocumentationGenerator

java.lang.Object

org.codehaus.cargo.documentation.ConfluenceProjectStructureDocumentationGenerator

public class ConfluenceProjectStructureDocumentationGenerator
extends Object

Generate project structure documentation using Confluence markup language. The generated text is meant to be copied on the Cargo Confluence web site. Warning: Uses a relative path to determine the base cargo directory and the sandbox is hard-coded.

Constructor Summary

Constructors

Constructor and Description
ConfluenceProjectStructureDocumentationGenerator()

Method Summary

Modifier and Type	Method and Description
String	generateDocumentation() Generates the project structure documentation.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfluenceProjectStructureDocumentationGenerator

public ConfluenceProjectStructureDocumentationGenerator()

Method Detail

generateDocumentation

public String generateDocumentation()
                             throws Exception

Generates the project structure documentation.

Returns:

the project structure documentation to write to file.

Throws:

Exception - if something unexpected occurs while generating documentation.