com.simplifiedlogic.nitro.jshell.json.help

Class JLJsonHelpHandler

java.lang.Object

com.simplifiedlogic.nitro.jshell.json.help.JLJsonHelpHandler

public class JLJsonHelpHandler
extends java.lang.Object

This is the main entry point for generating the JSON help doc.

Constructor Summary

Constructors

Constructor and Description
JLJsonHelpHandler()

Method Summary

Methods

Modifier and Type	Method and Description
java.util.List<JLJsonCommandHelp>	getHelps() Get the list of help-doc handlers, one per function family
java.util.List<FunctionObject>	getTemplateObjects() Get the list of help-doc shared objects for all function families
java.util.List<FunctionTemplate>	getTemplates() Get the list of help-doc function templates for all function families

Methods inherited from class java.lang.Object

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

Constructor Detail

JLJsonHelpHandler

public JLJsonHelpHandler()

Method Detail

getTemplates

public java.util.List<FunctionTemplate> getTemplates()

Get the list of help-doc function templates for all function families

Returns:

The list of function template objects

getTemplateObjects

public java.util.List<FunctionObject> getTemplateObjects()

Get the list of help-doc shared objects for all function families

Returns:

The list of shared objects

getHelps

public java.util.List<JLJsonCommandHelp> getHelps()

Get the list of help-doc handlers, one per function family

Returns:

The list of help handlers