edu.jhu.ece.iacl.doc
Class DocumentAllModules

java.lang.Object
  edu.jhu.ece.iacl.doc.DocumentAllModules

public class DocumentAllModules
extends java.lang.Object

Class automatically document module definitions

Author:

John Bogovic (bogovic@jhu.edu), Blake Lucas

Nested Class Summary

static class	DocumentAllModules.CompareFactories The Class CompareFactories.
protected class	DocumentAllModules.ModuleDescription

Constructor Summary

DocumentAllModules()
Default constructor.

DocumentAllModules(java.io.File path)

Method Summary

protected DocumentGenerator	createDocumentGenerator()
java.io.File	createPath(java.io.File discoveredPath, java.lang.String category)
void	documentModules() Searches for modules and writes documentation to file.
static void	main(java.lang.String[] args) Run me.

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentAllModules

public DocumentAllModules()

Default constructor.

DocumentAllModules

public DocumentAllModules(java.io.File path)

Method Detail

documentModules

public void documentModules()

Searches for modules and writes documentation to file.

createDocumentGenerator

protected DocumentGenerator createDocumentGenerator()

createPath

public java.io.File createPath(java.io.File discoveredPath,
                               java.lang.String category)

main

public static void main(java.lang.String[] args)

Run me.

Parameters:

args -