This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRIS, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions page (login required).

Home > Class Reference > ENSLIB namespace > %ZEN.Mojo.Plugin.baseHelperDocumentation

%ZEN.Mojo.Plugin.baseHelperDocumentation

abstract class %ZEN.Mojo.Plugin.baseHelperDocumentation extends %ZEN.Component.object

Superclass for all classes that provide documentation for subclasses of baseHelperPlugin. The classname needs to be the same as the classname of the helper plugin with "Documentation" as postfix. If the helper plugin classname is "chuiHelper", the documentation classname needs to be "chuiHelperDocumentation".

Method Inventory

Parameters

parameter NAMESPACE = http://www.intersystems.com/zen/mojo;
Inherited description: This is the XML namespace used for library components.

Methods

clientmethod getDocumentation(identifier) [ Language = javascript ]
returns an object containing information about the requested identifier (e.g. $loop). The object contains an array holding an object for each supported attribute and a documentation EXAMPLE: { description: 'Description of the identifier e.g. $loop', attributes: [ {name:'value',type:'string',description:'Holds the value of the html element'} ] } Valid types are: string,number,boolean,date,object,array and function

Inherited Members

Inherited Properties

Inherited Methods

Subclasses

FeedbackOpens in a new window