HelpSource/Classes/SCDocEntry.schelp

   1 title:: SCDocEntry
   2 summary:: An SCDoc document index entry
   3 related:: Classes/SCDoc
   4 categories:: HelpSystem
   5
   6 description::
   7 This class is used by link::Classes/SCDoc:: to represent a document in the help file index.
   8
   9 The document represented can be either a real .schelp file, or an auto-generated stub for undocumented classes.
  10
  11 classmethods::
  12
  13 method:: new
  14 Create and initialize a new instance.
  15 argument:: node
  16 An link::Classes/SCDocNode:: instance. Does not have to be a fully parsed document, since only the header tags, methods and keywords are used. (See link::Classes/SCDoc#*parseFileMetaData::).
  17
  18 argument:: path
  19 A link::Classes/String:: for the document key, like "Classes/SinOsc".
  20
  21 method:: newUndocClass
  22 Create and initialize a new instance for an undocumented class.
  23 argument:: name
  24 Name of undocumented class
  25
  26 instancemethods::
  27
  28 private:: prAddCopyMethod, prAddMethodNames, printOn, prJSONList, prJSONString, prScanMethodsKeywords, setAdditions, init, indexUndocumentedMethods
  29
  30 subsection:: Document properties
  31
  32 method:: path
  33 A link::Classes/String:: for the document key, like "Reference/SCDocSyntax".
  34
  35 method:: title
  36 Document title. Should equal the classname for class reference docs.
  37
  38 method:: summary
  39 Document summary.
  40
  41 method:: categories
  42 Document categories. An link::Classes/Array:: of Strings.
  43
  44 method:: related
  45 Related document links. An link::Classes/Array:: of Strings.
  46
  47 method:: keywords
  48 Keywords listed in the document. An link::Classes/Array:: of Strings.
  49
  50 method:: fullPath
  51 The full path to this documents .schelp file, if any.
  52
  53 method:: mtime
  54 The modification time of the .schelp file, if any.
  55
  56 method:: destPath
  57 The render destination path.
  58
  59 method:: docmethods
  60 Documented methods which are not class or instance methods. An link::Classes/Array:: of Strings.
  61
  62 method:: additions
  63 A list of document additions (*.ext.schelp) for this document. An link::Classes/Array:: of Strings.
  64
  65 method:: isExtension
  66 True if this document is an extension (not part of the main library). A link::Classes/Boolean::
  67
  68 method:: isClassDoc
  69 True if this document is a class doc. A link::Classes/Boolean::
  70
  71 subsection:: Class docs
  72 These methods and properties are only used for class docs.
  73
  74 method:: klass
  75 The link::Classes/Class:: documented.
  76
  77 method:: isUndocumentedClass
  78 True if this class is undocumented (which means there are no .schelp file).
  79 A link::Classes/Boolean::
  80
  81 method:: doccmethods
  82 A list of documented class methods.
  83
  84 method:: docimethods
  85 A list of documented instance methods.
  86
  87 method:: privcmethods
  88 A list of private class methods.
  89
  90 method:: privimethods
  91 A list of private instance methods.
  92
  93 method:: undoccmethods
  94 A list of undocumented class methods.
  95
  96 method:: undocimethods
  97 A list of undocumented instance methods.
  98
  99 method:: makeMethodList
 100 Return a list of strings for all non-private methods, prefixed with teletype::xy:: where x is teletype::_:: for documented methods and teletype::?:: for undocumented methods, and y is teletype::*:: for class methods, teletype::-:: for instance methods and teletype::.:: for other/generic methods.
 101
 102 method:: redirect
 103
 104 The name of the class variable holding the implementing class. Used by GUI redirection system, for example.
 105
 106 method:: implKlass
 107
 108 The implementing link::Classes/Class::, if code::redirect:: was set.
 109
 110 method:: implements
 111
 112 The link::Classes/Class:: being implemented. For example, the entry for link::Classes/QButton:: has this set to link::Classes/Button::
 113
 114 method:: toJSON
 115 Write a representation of this document entry as JSON to Stream. Used to export the document entries to the javascript used in the link::Classes/HelpBrowser##HTML help browser::.
 116 argument:: stream
 117 A Stream.
 118