Meta/System doc package

Library documentation for Meta/System doc package.

Workspaces:

  • MetaSystem::Doc:{classdg}:

  • MetaSystem::Doc:{flowchart}:

  • MetaSystem::Doc:{main}:

  • MetaSystem::Doc:{pie}:

MetaSystem::Doc:{classdg}:

Library documentation for MetaSystem::Doc:{classdg}: workspace.

<repr> #ClassDef

Members:

  • container: Store::Container

  • name: Data::String

<repr> #ClassRelation

Members:

  • class1: Data::String

  • class2: Data::String

  • name: Data::String

  • relation: Data::String

<repr> #Main

Members:

  • container: Store::Container

  • type: Data::String

<repr> #MemberDef

Members:

  • name: Data::String

  • type: Data::String

  • visibility: Data::String

<repr> #MethodDef

Members:

  • name: Data::String

  • returnType: Data::String

  • visibility: Data::String

<repr> #Stereotype

Members:

  • name: Data::String

MetaSystem::Doc:{flowchart}:

Library documentation for MetaSystem::Doc:{flowchart}: workspace.

<repr> #IdBox

Members:

  • id: Data::String

<repr> #Main

Members:

  • container: Store::Container

  • type: Data::String

<repr> #NamedBox

Members:

  • id: Data::String

  • name: Data::String

<repr> #StyleBox

Members:

  • id: Data::String

  • name: Data::String

  • style: BoxStyle

<enum> BoxStyle

Values:

  • Default

  • Round

  • Stadium

  • Subroutine

  • Database

  • Circle

<enum> LinkStyle

Values:

  • Default

  • Arrow

  • Dotted

MetaSystem::Doc:{main}:

Library documentation for MetaSystem::Doc:{main}: workspace.

<repr> #CodeFragment

Program code section.

Members:

  • longText: Data::String

  • parameter: Store::Container

  • returnText: Data::String

  • shortText: Data::String

<repr> #Document

Document AST root.

Members:

  • container: Store::Container

  • title: Data::String

<repr> #DynamicCode

Dynamic generated section.

Members:

  • code: Code::Block

<repr> #Font

Block with character font.

Members:

  • container: Store::Container

  • name: Data::String

<repr> #Link

Hyperlink.

Members:

  • alt: Data::String

  • text: Data::String

  • url: Data::String

<repr> #List

List section.

Members:

  • container: Store::Container

  • style: Data::String

<repr> #ListItem

List item.

Members:

  • container: Store::Container

Methods:

  • constructor (Data::String value)

<repr> #Object

Members:

  • container: Store::Container

<repr> #Paragraph

Paragraph section.

Members:

  • container: Store::Container

  • title: Data::String

Methods:

  • constructor (Data::String value)

<repr> #Parameter

Code parameter section.

Members:

  • defaultValue: Data::String

  • direction: Data::String

  • text: Data::String

  • type: Data::String

  • variable: Data::String

<repr> #Picture

Picture data.

Members:

  • name: Data::String

  • url: Data::String

<repr> #Section

Text section.

Members:

  • container: Store::Container

  • level: Data::Int32

  • title: Data::String

<repr> #Table

Table section.

Members:

  • container: Store::Container

<repr> #TableColumn

Table column.

Members:

  • content: Store::Single

<repr> #TableRow

Table row.

Members:

  • container: Store::Container

<parser> CodeDocParser

Code documentation parser class.

<clss> CodeDocReader

Code documentation reader.

Base classes:

  • System::GrammarInterface

Members:

  • result: Store::Single

Methods:

  • <mth> setTarget (Node target)

  • <mth> getTarget ()

  • <mth> setRepository (System::Repository repository)

  • <mth> importWorkspace (string workspaceName)

  • <mth> process (string fileName)

  • <mth> processSub (string fileName, string path)

  • <mth> processString (string buffer)

  • <mth> processOpened ()

  • <mth> processOpened (string fileName)

<clss> CodeParser

Documentation parser class.

Members:

Methods:

  • <mth> popGroup ()

  • <mth> addText (Data::String line, Store::Container container)

  • <mth> parse (Data::String stringContent)

<clss> GrammarInterface

Documentation reader.

Base classes:

  • System::GrammarInterface

Members:

  • result: Store::Single

Methods:

  • <mth> setTarget (Node target)

  • <mth> getTarget ()

  • <mth> setRepository (System::Repository repository)

  • <mth> importWorkspace (string workspaceName)

  • <mth> process (string fileName)

  • <mth> processSub (string fileName, string path)

  • <mth> processString (string buffer)

  • <mth> processOpened ()

  • <mth> processOpened (string fileName)

<clss> Node2Doc

Convert node content to raw documentation.

Members:

  • codeDoc: System::Parser

  • needDefinition: Data::Bool

  • needDiagrams: Data::Bool

  • startSectionLevel: Data::Int32

  • title: Data::String

  • useFullNames: Data::Bool

  • usePrivate: Data::Bool

  • useShortTags: Data::Bool

  • useSubSections: Data::Bool

Methods:

  • constructor ()

  • <mth> process (Node source)

    Process source content and return a document AST.

  • <mth> generateDoc (#CodeFragment fragment)

  • <mth> generateDescription (Node node, Store::Container output)

  • <mth> generateBaseClasses (Store::Vector superClasses, Store::Container output)

  • <mth> generateBaseClasses2 (Store::Vector superClasses, MetaSystem::Doc:{classdg}:#Main dg, Data::String className)

  • <mth> generateMembers (Store::Map members, Store::Container output)

  • <mth> generateMembers2 (Store::Map members, MetaSystem::Doc:{classdg}:#ClassDef classDef)

  • <mth> generateDefinition (Node node, Store::Container output)

  • <mth> generateSection (Node node, Store::Container output)

  • <mth> generateContent (Store::Container container, Store::Container output)

  • <mth> generateMethodContent (Store::Container container, Store::Container output)

  • <mth> generateContent2 (Store::Container container, MetaSystem::Doc:{classdg}:#ClassDef classDef)

  • <mth> generateMetaContent (Store::Container container, Store::Container output)

  • <mth> getShortName (Data::String name)

  • <mth> getWorkspaceName (Data::String name)

<fn> ParseCodeDoc(Data::String stringContent)

Code documentation parser function.

<fn> ParseDoc(Data::String stringContent)

Documentation reader function.

<parser> Parser

Documentation parser.

MetaSystem::Doc:{pie}:

Library documentation for MetaSystem::Doc:{pie}: workspace.

<repr> #Element

Members:

  • name: Data::String

  • value: Data::Float

<repr> #Main

Members:

  • container: Store::Container

  • title: Data::String

  • type: Data::String