org.fhcrc.cpl.toolbox.commandline
Class CLMUserManualGenerator

java.lang.Object
  org.fhcrc.cpl.toolbox.commandline.CLMUserManualGenerator

Direct Known Subclasses:

ViewerUserManualGenerator

public class CLMUserManualGenerator
extends java.lang.Object

test

Field Summary

protected static org.apache.log4j.Logger

_log

Constructor Summary

CLMUserManualGenerator()

Method Summary

void	generateCommandManualEntry(CommandLineModule moduleToDocument, java.io.Writer outW) Generate manual entry for a single command, in its own doc
void	generateFullManual(java.io.Writer outW) generate a full user manual
CommandLineModuleDiscoverer	getCommandLineModuleDiscoverer()
void	writeIntro(java.io.Writer outW) Write a manual introduction.
void	writeTOCAndManualBody(java.io.Writer outW) Write a table of contents

Methods inherited from class java.lang.Object

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

Field Detail

_log

protected static org.apache.log4j.Logger _log

Constructor Detail

CLMUserManualGenerator

public CLMUserManualGenerator()

Method Detail

generateFullManual

public void generateFullManual(java.io.Writer outW)
                        throws java.io.IOException

generate a full user manual

Throws:

java.io.IOException

getCommandLineModuleDiscoverer

public CommandLineModuleDiscoverer getCommandLineModuleDiscoverer()

writeTOCAndManualBody

public void writeTOCAndManualBody(java.io.Writer outW)
                           throws java.io.IOException

Write a table of contents

Parameters:

outW -

Throws:

java.io.IOException

writeIntro

public void writeIntro(java.io.Writer outW)
                throws java.io.IOException

Write a manual introduction. This should be overridden by a class specific to the application

Parameters:

outW -

Throws:

java.io.IOException

generateCommandManualEntry

public void generateCommandManualEntry(CommandLineModule moduleToDocument,
                                       java.io.Writer outW)
                                throws java.io.IOException

Generate manual entry for a single command, in its own doc

Parameters:

moduleToDocument -

outW -

Throws:

java.io.IOException