Class MaisDocGenerator

java.lang.Object

org.x4o.maisdoc.flake.MaisDocGenerator

All Implemented Interfaces:

MaisDocContentPrinter

public class MaisDocGenerator
extends Object
implements MaisDocContentPrinter

ApiDocWriter creates all output files for the ApiDoc.

Version:

1.0 May 1, 2013

Author:

Willem Cazander

Constructor Summary

Constructors

Constructor	Description
MaisDocGenerator()

Method Summary

Modifier and Type	Method	Description
protected void	configNodeData(String prefixPath, File frame)
void	defaultWriteSummary(MaisDocNode node, MaisDocContentWriter writer)
void	defaultWriteTreePath(MaisDocNode node, MaisDocContentWriter writer)
static ClassLoader	findClassLoader()
void	write(MaisDoc doc, File basePath)	Writes full api doc tree files to the base path.
void	writeAllFrameNav(boolean isFrame)
void	writeIndex()
void	writeOverviewFrame()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.x4o.maisdoc.flake.MaisDocContentPrinter

clearHrefContentGroup, clearHrefContentGroupAlways, printApiTable, printApiTable, printApiTableBean, printApiTableBean, printApiTableBeanClass

Constructor Details

MaisDocGenerator

public MaisDocGenerator()

Method Details

write

public void write(MaisDoc doc,
 File basePath)
           throws IOException

Writes full api doc tree files to the base path.

Parameters:

doc - The ApiDoc to writer.

basePath - The bath path to write into.

Throws:

IOException - When file exception happens.

configNodeData

protected void configNodeData(String prefixPath,
 File frame)
                       throws IOException

Throws:

IOException

defaultWriteSummary

public void defaultWriteSummary(MaisDocNode node,
 MaisDocContentWriter writer)
                         throws IOException

Throws:

IOException

defaultWriteTreePath

public void defaultWriteTreePath(MaisDocNode node,
 MaisDocContentWriter writer)
                          throws IOException

Throws:

IOException

writeIndex

public void writeIndex()
                throws IOException

Throws:

IOException

writeOverviewFrame

public void writeOverviewFrame()
                        throws IOException

Throws:

IOException

writeAllFrameNav

public void writeAllFrameNav(boolean isFrame)
                      throws IOException

Throws:

IOException

findClassLoader

public static ClassLoader findClassLoader()