ar.com.jmfsg.documentation.model
Class Documentation

java.lang.Object
  ar.com.jmfsg.documentation.model.Documentation

public class Documentation
extends Object

The Root of the Documentation hierarchy

Author:

gvinokur

Field Summary

List<DictionaryEntry>	dictionary Globally defined dictionary.
General	general General Documentation for the application
List<Map<String,Group>>	groups Group specific documentation
List<Map<String,Method>>	methods List of Method|methods that are available throught this application
List<Tag>	tags Globally defined tags that can be applied to the methods

Constructor Summary

Documentation()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

general

public General general

General Documentation for the application

methods

public List<Map<String,Method>> methods

List of Method|methods that are available throught this application

tags

public List<Tag> tags

Globally defined tags that can be applied to the methods

groups

public List<Map<String,Group>> groups

Group specific documentation

dictionary

public List<DictionaryEntry> dictionary

Globally defined dictionary.
Any property defined here will have the description expanded the same way anywhere in the documentation.

Constructor Detail

Documentation

public Documentation()