Return a negative integer, zero, or a positive integer if this object is less than, equal to, or greater than the specified object:
this < that => <0
this == that => 0
this > that => >0
This method may also be accessed via the < <= <=> >= and >
shortcut operators. If not overridden the default
implementation compares the toStr
representations. Also see docLang.
Examples:
3.compare(8) => -1
8.compare(3) => 1
8.compare(8) => 0
3 <=> 8 => -1 // shortcut for 3.compare(8)
Filename to use the CSS include
Lookup a document by is spaceName and docName within that space. If not found then return null or raise UnknownDocErr. Default implementation delegates to space and DocSpace.doc.
Optionalchecked: booleanCompare this object to the specified for equality. This
method may be accessed via the == and != shortcut operators.
If not overridden the default implementation compares for
reference equality using the === operator. If this method
is overridden, then hash() must also be overridden such that
any two objects which return true for equals() must return
the same value for hash(). This method must accept null and
return false.
Footer for documentation pages to indicate version/timestamp
Generate full html envelope or only content div
Return a unique hashcode for this object. If a class overrides hash() then it must ensure if equals() returns true for any two objects then they have same hash code.
Check embedded image link in a document. If it maps to a resource file we should include, then return the file. Otherwise raise warning exception.
Return URI used to link the from doc to the target doc. Also see linkUriExt.
Return the file extension (including the dot) to suffix all link URIs. Default returns ".html"
Underlying namespace of defs
Documentation web site title
Theme
Get an immutable representation of this instance or throw NotImmutableErr if this object cannot be represented as an immutable:
Top index with our custom index renderer
Return a string representation of this object.
Trap a dynamic call for handling. Dynamic calls are invoked with the -> shortcut operator:
a->x a.trap("x", null)
a->x() a.trap("x", null)
a->x = b a.trap("x", [b])
a->x(b) a.trap("x", [b])
a->x(b, c) a.trap("x", [b, c])
The default implementation provided by Obj attempts to use reflection. If name maps to a method, it is invoked with the specified arguments. If name maps to a field and args.size is zero, get the field. If name maps to a field and args.size is one, set the field and return args[0]. Otherwise throw UnknownSlotErr.
Timestamp when docs generated
Iterate chapter toc links
Iterate only top-level chapter toc links
This method called whenever an it-block is applied to an
object. The default implementation calls the function with this,
and then returns this.
StaticechoWrite x.toStr to standard output followed by newline. If x
is null then print "null". If no argument is provided then
print an empty line.
Optionalx: JsObjStaticmake
DefDocEnv is the defc implementatin of DocEnv