com.simplifiedlogic.nitro.jshell.funcs

Class ServerJsonHelp

java.lang.Object

com.simplifiedlogic.nitro.jshell.funcs.ServerJsonHelp

All Implemented Interfaces:

ServerRequestParams, ServerResponseParams

public class ServerJsonHelp
extends java.lang.Object
implements ServerRequestParams, ServerResponseParams

Generate help doc for server-family functions

Field Summary

Fields inherited from interface com.simplifiedlogic.nitro.jshell.funcs.ServerRequestParams

COMMAND, FUNC_PWD

Fields inherited from interface com.simplifiedlogic.nitro.jshell.funcs.ServerResponseParams

OUTPUT_DIRNAME

Constructor Summary

Constructors

Constructor and Description
ServerJsonHelp()

Method Summary

Methods

Modifier and Type	Method and Description
java.util.List<FunctionTemplate>	getHelp() Generates a list of help doc objects for all the functions in the family
java.util.List<FunctionObject>	getHelpObjects() Generates a list of help doc objects for all the shared data objects in the family

Methods inherited from class java.lang.Object

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

Constructor Detail

ServerJsonHelp

public ServerJsonHelp()

Method Detail

getHelp

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

Generates a list of help doc objects for all the functions in the family

Returns:

A list of FunctionTemplate objects

getHelpObjects

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

Generates a list of help doc objects for all the shared data objects in the family

Returns:

A list of FunctionObject objects