SCDocEntry: table of contents
Filter:
Classes | HelpSystem

SCDocEntry : Object

An SCDoc document index entry
Source: SCDoc.sc

Description

This class is used by SCDoc to represent a document in the help file index.

The document represented can be either a real .schelp file, or an auto-generated stub for undocumented classes.

Class Methods

SCDocEntry.new(node, path)

Create and initialize a new instance.

Arguments:

node

An SCDocNode instance. Does not have to be a fully parsed document, since only the header tags, methods and keywords are used. (See SCDoc: *parseFileMetaData).

path

A String for the document key, like "Classes/SinOsc".

SCDocEntry.newUndocClass(name)

Create and initialize a new instance for an undocumented class.

Arguments:

name

Name of undocumented class

Inherited class methods

Instance Methods

Document properties

.path

.path = value

A String for the document key, like "Reference/SCDocSyntax".

.title

.title = value

Document title. Should equal the classname for class reference docs.

.summary

.summary = value

Document summary.

.categories

.categories = value

Document categories. An Array of Strings.

.related

.related = value

Related document links. An Array of Strings.

.keywords

.keywords = value

Keywords listed in the document. An Array of Strings.

.fullPath

.fullPath = value

The full path to this documents .schelp file, if any.

.mtime

.mtime = value

The modification time of the .schelp file, if any.

.destPath

The render destination path.

.docmethods

.docmethods = value

Documented methods which are not class or instance methods. An Array of Strings.

.additions

.additions = value

A list of document additions (*.ext.schelp) for this document. An Array of Strings.

.isExtension

.isExtension = value

True if this document is an extension (not part of the main library). A Boolean

.isClassDoc

.isClassDoc = value

True if this document is a class doc. A Boolean

Class docs

These methods and properties are only used for class docs.

.klass

.klass = value

The Class documented.

.isUndocumentedClass

.isUndocumentedClass = value

True if this class is undocumented (which means there are no .schelp file). A Boolean

.doccmethods

.doccmethods = value

A list of documented class methods.

.docimethods

.docimethods = value

A list of documented instance methods.

.privcmethods

.privcmethods = value

A list of private class methods.

.privimethods

.privimethods = value

A list of private instance methods.

.undoccmethods

.undoccmethods = value

A list of undocumented class methods.

.undocimethods

.undocimethods = value

A list of undocumented instance methods.

.makeMethodList

Return a list of strings for all non-private methods, prefixed with xy where x is _ for documented methods and ? for undocumented methods, and y is * for class methods, - for instance methods and . for other/generic methods.

.redirect

.redirect = value

The name of the class variable holding the implementing class. Used by GUI redirection system, for example.

.implKlass

.implKlass = value

The implementing Class, if redirect was set.

.implements

.implements = value

The Class being implemented. For example, the entry for QButton has this set to Button

.toJSON(stream)

Write a representation of this document entry as JSON to Stream. Used to export the document entries to the javascript used in the HTML help browser.

Arguments:

stream

A Stream.

Inherited instance methods

Undocumented instance methods

.oldHelp

.oldHelp = value