OpDocs
op documentation loading
Constructor Summary
| Public Constructor | ||
| public |
|
|
Member Summary
| Public Members | ||
| public |
coreLibs: *[] |
|
| public |
libs: *[] |
|
| Private Members | ||
| private |
_extensions: *[] |
|
| private |
_opDocs: *[] |
|
| private |
_teamnamespaces: *[] |
|
| private |
log: * |
|
Method Summary
| Public Methods | ||
| public |
|
|
| public |
addOpDocs(opDocs: *[]) |
|
| public |
addTypeStringToPorts(ports: array) Creates a "typeString" attribute for each port-object in the array (e.g. |
|
| public |
|
|
| public |
extendOpDocs(_opDocs: array) Adds some properties to each doc in the op docs array |
|
| public |
getAll(): * |
|
| public |
getAttachmentFiles(opname: string): *[] |
|
| public |
getExtensions(): * |
|
| public |
getHtml(opName: string, collectionInfo: *): * Returns the documentation for an op as Html |
|
| public |
getLayoutSvg(opname: string): * |
|
| public |
getNamespaceDocs(ns: string): * |
|
| public |
getOpDocById(opId: string): * Returns the op documentation object for an op |
|
| public |
getOpDocByName(opName: string): * Returns the op documentation object for an op |
|
| public |
getOpDocs(): * |
|
| public |
getPortDoc(op_docs: Object, portname: string, type: number): * |
|
| public |
getPortDocText(port: Object, opDoc: Object): string Checks for the existence of a documentation text for the port with name |
|
| public |
getStats(): {"countCoreOps": *, "countTeamOps": *, "countExtensionOps": *, "countUserOps": *} |
|
| public |
getSummary(opname: string): number |
|
| public |
getTeamNamespaces(): * |
|
| public |
removeOpDoc(opDoc: *) |
|
| public |
setPortDocTexts(ports: Object, opDoc: Object) Sets a |
|
| public |
showPortDoc(opname: string, portname: string) |
|
Public Constructors
public constructor() source
Public Members
public coreLibs: *[] source
public libs: *[] source
Private Members
private _extensions: *[] source
private _opDocs: *[] source
private _teamnamespaces: *[] source
private log: * source
Public Methods
public addCoreOpDocs() source
public addOpDocs(opDocs: *[]) source
Params:
| Name | Type | Attribute | Description |
| opDocs | *[] |
|
public addTypeStringToPorts(ports: array) source
Creates a "typeString" attribute for each port-object in the array (e.g. "Value")
Params:
| Name | Type | Attribute | Description |
| ports | array | Array of port objects with a "type" attribute |
public checkDefaultOpsOutdated() source
public extendOpDocs(_opDocs: array) source
Adds some properties to each doc in the op docs array
Params:
| Name | Type | Attribute | Description |
| _opDocs | array | The array of op docs |
public getAttachmentFiles(opname: string): *[] source
Params:
| Name | Type | Attribute | Description |
| opname | string |
Return:
| *[] |
public getHtml(opName: string, collectionInfo: *): * source
Returns the documentation for an op as Html
Params:
| Name | Type | Attribute | Description |
| opName | string | The name of the op to get the documentation as Html for |
|
| collectionInfo | * |
Return:
| * |
public getLayoutSvg(opname: string): * source
Params:
| Name | Type | Attribute | Description |
| opname | string |
Return:
| * |
public getNamespaceDocs(ns: string): * source
Params:
| Name | Type | Attribute | Description |
| ns | string |
Return:
| * |
public getOpDocById(opId: string): * source
Returns the op documentation object for an op
Params:
| Name | Type | Attribute | Description |
| opId | string |
Return:
| * |
public getOpDocByName(opName: string): * source
Returns the op documentation object for an op
Params:
| Name | Type | Attribute | Description |
| opName | string | Complete op name (long form), e.g. "Ops.Value" |
Return:
| * |
public getPortDoc(op_docs: Object, portname: string, type: number): * source
Params:
| Name | Type | Attribute | Description |
| op_docs | Object | ||
| portname | string | ||
| type | number |
Return:
| * |
public getPortDocText(port: Object, opDoc: Object): string source
Checks for the existence of a documentation text for the port with name port.name
Params:
| Name | Type | Attribute | Description |
| port | Object | The port-object containing a |
|
| opDoc | Object | The doc object of the op |
Return:
| string | The documeentation for the port as html (markdown parsed) |
public getStats(): {"countCoreOps": *, "countTeamOps": *, "countExtensionOps": *, "countUserOps": *} source
Return:
| {"countCoreOps": *, "countTeamOps": *, "countExtensionOps": *, "countUserOps": *} |
public getSummary(opname: string): number source
Params:
| Name | Type | Attribute | Description |
| opname | string |
Return:
| number |
public removeOpDoc(opDoc: *) source
Params:
| Name | Type | Attribute | Description |
| opDoc | * |
public setPortDocTexts(ports: Object, opDoc: Object) source
Sets a text property for each port with the documentation
Params:
| Name | Type | Attribute | Description |
| ports | Object | Array-like object with ports |
|
| opDoc | Object | The op doc |
public showPortDoc(opname: string, portname: string) source
Params:
| Name | Type | Attribute | Description |
| opname | string | ||
| portname | string |