Filters

Class ${:name} [:?var :@superclass { - subclass of [:for super ${:@superclass} { [$super name] }] }]

[:?var :@see {
See also:${:@see}
}]
[:text]

Class parameters

[:?var :@class-param { [:for attr ${:@class-param} {

[$attr name]

[$attr text]
[:? {[$attr eval {info exists :default}]} {
Default Value: [$attr default]
}] [:? {[$attr eval {info exists :deprecated}]} {
Deprecated: [$attr default]
}]
}] }]
[:let iattrs [:inherited @class-param]] [:? {$iattrs ne ""} {
[:for superclass [dict keys $iattrs] { [:let attrs [dict get $iattrs $superclass]]

Object parameters inherited from [$superclass name]:

[:for a $attrs { [$a name] }]
}]
}]

Object parameters

[:?var :@object-param { [:for attr ${:@object-param} {

[$attr name]

[$attr text]
[:? {[$attr eval {info exists :default}]} {
Default Value: [$attr default]
}] [:? {[$attr eval {info exists :deprecated}]} {
Deprecated: [$attr]
}]
}] }]

Class methods

[:?var :@class-method { [:for method ${:@class-method} {

[$method name]

[:? {[$method eval {info exists :@return}] && [[$method @return] spec] ne ""} {<[[$method @return] spec]>} ] [$method name] [$method parameters] [:? {[$method has_property interally-called]} {
Internally called method, can be redefined. }] [:? {[[:name] info methods [$method name]] ne "" && [::nsf::methodproperty [:name] [$method name] redefine-protected]} {
Method is redefine-protected }]
[$method text]
[:? {[$method eval {info exists :@param}]} {
Method parameters:
[:for param [$method @param] {
[$param name] [:? {[$param eval {info exists :spec}] && [$param spec] ne ""} {<[$param spec]>}] [$param text] [:? {[$param eval {info exists :default}]} {
Default Value: [$param default]
}]
}]
}] [:? {[$method eval {info exists :@return}]} { [:let rparam [$method @return]]
Returns:
[$rparam text]
}] [:? {[$method eval {info exists :@deprecated}]} {
Deprecated [$method @deprecated]
}] [:? {[[:name] info methods [$method name]] ne ""} {
Method type: [[:name] info method type [$method name]] }]
}] }]
[:let imethods [:inherited @class-method]] [:? {$imethods ne ""} {
[:for superclass [dict keys $imethods] { [:let ms [dict get $imethods $superclass]]

Methods inherited from [$superclass name]:

[:for m $ms { [$m name] }]
}]
}] [:?var :@method { Undocumented Methods: [:undocumented] }]
[:?var :@object-method {

Object methods

[:for omethod ${:@object-method} {

[$omethod name]

[:? {[$omethod eval {info exists :@return}]} {<[[$omethod @return] spec]>} ] [$omethod name] [$omethod parameters]
[$omethod text]
[:? {[$omethod eval {info exists :@param}]} {
Method parameters:
[:for param [$omethod @param] {
[$param name] [:? {[$param eval {info exists :spec}] && [$param spec] ne ""} {<[$param spec]>}] [$param text]
}]
}] [:? {[$omethod eval {info exists :@return}]} { [:let rparam [$omethod @return]]
Returns:
[$rparam text]
}] [:? {[$omethod eval {info exists :@deprecated}]} {
Deprecated [$method @deprecated]
}]
}]
}]