String to use for this space in the breadcrumb. By default this is the spaceName.
Find a chapter by name. If the chapter doesn't exist and checked is false then return null, otherwise throw Err.
Optionalchecked: booleanIf this is a manual like docLang, return list of chapters.
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)
Find the document with the given name. If not found raise UnknownDocErr or return null based on checked flag. The document namespace of a pod is:
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.
File the pod was loaded from
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.
Document which models the index page for this pod
A manual pod is a pod with two or more fandoc chapters and no types.
Simple name of the pod such as "sys".
If this pod has an associated pod.fandoc chapter
Return resource for filename, or if not available return null/raise exception. This filenames is always relative to doc/ sub-directory.
Optionalchecked: booleanSpace name is same as name
Return source code for filename, or if not available return null/raise exception.
Optionalchecked: booleanSummary string for the pod
Get an immutable representation of this instance or throw NotImmutableErr if this object cannot be represented as an immutable:
Always return name.
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.
Get the build timestamp or null if not available
Find a type by name. If the type doesn't exist and checked is false then return null, otherwise throw UnknownTypeErr.
Optionalchecked: booleanVersion number for this pod.
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: JsObjStaticloadStaticloadStaticmake
DocPod models the documentation of a sys::Pod.