Class EldDocWriter

java.lang.Object

org.x4o.xml.eld.doc.EldDocWriter

public class EldDocWriter
extends Object

EldDocWriter writes the x4o eld documentation.

Version:

1.0 Aug 26, 2010

Author:

Willem Cazander

Field Summary

Fields

Modifier and Type	Field	Description
static final SAX3PropertyConfig	DEFAULT_PROPERTY_CONFIG
static final String	DOC_ABOUT
static final String	DOC_COPYRIGHT
static final String	DOC_DESCRIPTION
static final String	DOC_NAME
static final String	DOC_PAGE_SUB_TITLE
static final String	JAVADOC_LINK
static final String	JAVADOC_LINK_OFFLINE
static final String	META_KEYWORDS
static final String	META_STYLESHEET
static final String	META_STYLESHEET_THEMA
static final String	OUTPUT_PATH
static final String	PAGE_PRINT_HELP
static final String	PAGE_PRINT_INDEX_ALL
static final String	PAGE_PRINT_TREE
static final String	PAGE_PRINT_XTREE

Constructor Summary

Constructors

Constructor	Description
EldDocWriter(X4OLanguage language, SAX3PropertyConfig parentConfig)	Creates an EldDocGenerator for this langauge context.

Method Summary

Modifier and Type	Method	Description
void	writeDocumentation()	Writes the language documentation to the base path.

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_PROPERTY_CONFIG

public static final SAX3PropertyConfig DEFAULT_PROPERTY_CONFIG

OUTPUT_PATH

public static final String OUTPUT_PATH

See Also:

• Constant Field Values

DOC_NAME

public static final String DOC_NAME

See Also:

• Constant Field Values

DOC_DESCRIPTION

public static final String DOC_DESCRIPTION

See Also:

• Constant Field Values

DOC_ABOUT

public static final String DOC_ABOUT

See Also:

• Constant Field Values

DOC_COPYRIGHT

public static final String DOC_COPYRIGHT

See Also:

• Constant Field Values

DOC_PAGE_SUB_TITLE

public static final String DOC_PAGE_SUB_TITLE

See Also:

• Constant Field Values

META_KEYWORDS

public static final String META_KEYWORDS

See Also:

• Constant Field Values

META_STYLESHEET

public static final String META_STYLESHEET

See Also:

• Constant Field Values

META_STYLESHEET_THEMA

public static final String META_STYLESHEET_THEMA

See Also:

• Constant Field Values

JAVADOC_LINK

public static final String JAVADOC_LINK

See Also:

• Constant Field Values

JAVADOC_LINK_OFFLINE

public static final String JAVADOC_LINK_OFFLINE

See Also:

• Constant Field Values

PAGE_PRINT_TREE

public static final String PAGE_PRINT_TREE

See Also:

• Constant Field Values

PAGE_PRINT_XTREE

public static final String PAGE_PRINT_XTREE

See Also:

• Constant Field Values

PAGE_PRINT_INDEX_ALL

public static final String PAGE_PRINT_INDEX_ALL

See Also:

• Constant Field Values

PAGE_PRINT_HELP

public static final String PAGE_PRINT_HELP

See Also:

• Constant Field Values

Constructor Details

EldDocWriter

public EldDocWriter(X4OLanguage language,
 SAX3PropertyConfig parentConfig)

Creates an EldDocGenerator for this langauge context.

Parameters:

language - The language to generate doc for.

Method Details

writeDocumentation

public void writeDocumentation()
                        throws ElementException

Writes the language documentation to the base path.

Throws:

ElementException - Is thrown when error is done.