Index: library/lib/doc-assets/@class.html.asciidoc
===================================================================
diff -u
--- library/lib/doc-assets/@class.html.asciidoc (revision 0)
+++ library/lib/doc-assets/@class.html.asciidoc (revision 77c371a2e4a1bd85367d11869de6e2dc9fac4771)
@@ -0,0 +1,106 @@
+
+[:as_text]
+
+[:?var :@class-attribute {
+[:!let class_attrs [:!get -sortedby name -with name @class-attribute]]
+}]
+
+
+
Provided Parameters
+ [:? {[info exists class_attrs]} {
+
+
+ [:for attr [dict values $class_attrs] {
+ [$attr name]
+ }]
+
+
+ }]
+ [:!let iattrs [:inherited @class-attribute]]
+ [:? {$iattrs ne ""} {
+ [:for superclass [dict keys $iattrs] {
+ [:!let attrs [dict values [dict get $iattrs $superclass]]]
+
Parameters inherited from [$superclass name]
+
+
+ [:for a $attrs {
+ [$a name]
+ }]
+
+
+ }]
+ }]
+
+ [:? {[info exists class_attrs]} {
+
+ [:for attr [dict values $class_attrs] {
+
+
+ [$attr name]
+
+
[$attr as_text]
+ }]
+
+ }]
+
+
Provided Methods
+ [:? {[info exists class_methods]} {
+
+
+ [:for m $class_methods {
+ [$m name]
+ }]
+
+
+ }]
+ [:!let imethods [:inherited @class-method]]
+ [:? {$imethods ne ""} {
+ [:for superclass [dict keys $imethods] {
+ [:!let ms [dict values [dict get $imethods $superclass]]]
+
Methods inherited from [$superclass name]
+
+
+ [:for m $ms {
+ [$m name]
+ }]
+
+
+ }]
+ }]
+
+ [:? {[info exists class_methods]} {
+ [:for m $class_methods {
+ [:? {[info exists class_attrs] && [dict exists $class_attrs [$m name]]} {
+ [$m render -initscript [list set owning_attribute [dict get $class_attrs [$m name]]] -template attributemethod]
+ } - {
+ [$m render]
+ }]
+ }]
+ }]
+
+
Per-Object Methods
+
+
+ [:for om $omethods {
+ [$om name]
+ }]
+
+
+ [:for om $omethods {
+ [$om render]
+ }]
+
+ Class
+ [:print_name -status]
+ [:?var :@superclass {
+
+ - subclass of
+ [:for super ${:@superclass} {
+ [$super name]
+ }]
+
+ }]
+
+
+[:?var :@see {
+See also: ${:@see}
+}]
+
+
+ [:as_text]
+
+
+[:?var :@class-attribute {
+[:!let class_attrs [:!get -sortedby name -with name @class-attribute]]
+
+
+
Provided Parameters
+
+
+ These parameter can be used to configure instances of this class:
+
+ [:for attr [dict values $class_attrs] {
+
+ [$attr name]
+
+ }]
+
+
+
+
+
+ [:for attr [dict values $class_attrs] {
+
+
+
+
+ [:? {[$attr pinfo exists validation]} {
+ [$attr pinfo get validation]
+ }]
+ [$attr as_text]
+
+
+
+
+ [:?objvar $attr default {
+
+ Default Value: $default
+
+ }]
+
+ [:? {[$attr eval {info exists :deprecated}]} {
+
+ Deprecated: [$attr default]
+
+ }]
+
+
+
+ }]
+
+
+
+ [:for superclass [dict keys $iattrs] {
+ [:!let attrs [dict values [dict get $iattrs $superclass]]]
+
+
+
+
+ [:for a $attrs {
+
+ [$a name]
+
+ }]
+
+
+
+ }]
+
+
+
Per-object parameters
+
+
+ [:for attr ${:@object-attribute} {
+
+
+
+
+
+ [:? {[$attr eval {info exists :default}]} {
+
+ Default Value: [$attr default]
+
+ }]
+
+ [:? {[$attr eval {info exists :deprecated}]} {
+
+ Deprecated: [$attr]
+
+ }]
+
+
+
+
+ }]
+
+
+
+
+
Provided Methods
+
+
+
+ [:for m $class_methods {
+
+ [$m name]
+
+ }]
+
+
+
+
+
+ [:for method $class_methods {
+ [:? {[info exists class_attrs] && [dict exists $class_attrs [$method name]]} {
+ [$method render -initscript [list set owning_attribute [dict get $class_attrs [$method name]]] -template attributemethod]
+ } - {
+ [$method render]
+ }]
+ }]
+
+
+
+ [:for superclass [dict keys $imethods] {
+ [:!let ms [dict values [dict get $imethods $superclass]]]
+
+
+
+
+ [:for m $ms {
+
+ [$m name]
+
+ }]
+
+
+
+ }]
+
+
+
Per-object methods
+
+
+ [:for m $omethods {
+
+ [$m name]
+
+ }]
+
+
+
+
+ [:for omethod $omethods {
+ [$omethod render]
+ }]
+
+
+
+ [:as_text]
+
+Usage
+${:name}
+ [:pinfo get -default "" bundle parametersyntax]
+
+[:?var :@command {
+[:!let subs [:!get -sortedby name @command]]
+[:for sub $subs {
+
+
+
+ ${:name} [$sub name]
+
+
+ [$sub as_text]
+ Usage
+ ${:name} [$sub name] [:pinfo get -default "" bundle parametersyntax]
+ [:?objvar $sub @parameter {
+ Parameters
+
+ [:for param [$sub !get @parameter] {
+
[$param print_name]
+
[$param as_text]
+ }]
+
Return
+ [:!let ret [$sub !get @return]]
+ [$ret as_text]
+ }]
+
+
Parameters
+
+ [:for param [:!get @parameter] {
+
[$param print_name]
+
[$param as_text]
+ }]
+
Return
+[:!let ret [:!get @return]]
+[$ret as_text]
+}]
+}]
+
+
+
+
+
+
+
Index: library/lib/doc-assets/@command.html.yuidoc
===================================================================
diff -u
--- library/lib/doc-assets/@command.html.yuidoc (revision 0)
+++ library/lib/doc-assets/@command.html.yuidoc (revision 77c371a2e4a1bd85367d11869de6e2dc9fac4771)
@@ -0,0 +1,117 @@
+
+ Command [:print_name -status]
+
+
+ [:as_text]
+
+[join [:pinfo get -default "" validation]
+
+
[:? {[info exists :@return] && [${:@return} spec] ne ""} {<[${:@return} spec] >} ]
+ ${:name}
+ [:pinfo get -default "" bundle parametersyntax]
+
+ [:?var :@command {
+
+
+
+
Subcommands
+
+
+
+ [:for sub [:!get -sortedby name @command] {
+
+ [$sub name]
+
+ }]
+
+
+
+
+
+ [:for sub [:!get -sortedby name @command] {
+
+
+
+
[:? {[$sub eval {info exists :@return}] && [[$sub @return] spec] ne ""} {<[[$sub @return] spec] >} ]
+ ${:name} [$sub name]
+ [$sub pinfo get -default "" bundle parametersyntax]
+
+
+ [$sub as_text]
+ [:?objvar $sub @parameter {
+
+ Parameters:
+ [:for param [$sub !get @parameter] {
+
+ [$param name]
+ [:? {[$param eval {info exists :spec}] && [$param spec] ne ""} {<[$param spec] >}]
+ [$param as_text]
+ [join [$param pinfo get -default "" validation]
+
+ }]
+
+ }]
+ [:?objvar $sub @return {
+ [:!let subreturn [$sub @return]]
+
+ Returns:
+
+
+ [$subreturn as_text][join [$subreturn pinfo get -default "" validation]
+
+ }]
+
+
+
+
+ }]
+
+
+
+
+ } - {
+
+
+ [:?var :@parameter {
+
+ Parameters:
+ [:for param [:!get @parameter] {
+
+ [$param name]
+ [:? {[$param eval {info exists :spec}] && [$param spec] ne ""} {<[$param spec] >}]
+ [$param as_text]
+ [join [$param pinfo get -default "" validation]
+
+ }]
+
+ }]
+
+ [:?var :@return {
+
+ Returns:
+
+
+ [${:@return} as_text]
+
+ }]
+
+
+ }]
+
+
+
+ [:name]
+
+
+ obj [:name] [:pinfo get -default "" bundle parametersyntax]
+ [:?var :@method {
+ [:for sm [:get_sub_methods] {
+ [$sm render -initscript [list set supermethod [current]] -template submethod]
+ }]
+ } - {
+ [:?var :@parameter {
+ Parameters
+
+ [:for param [:!get @parameter] {
+ [$param print_name] [$param as_text]
+ }]
+
+ }]
+ [:?var :@return {
+ Return
+ [:!let ret [:!get @return]]
+ [$ret as_text]
+ }]
+ }]
+
+
+
+
+
[:? {[info exists :@return] && [${:@return} spec] ne ""} {<[${:@return} spec] >} ]
+ obj
+ ${:name}
+ [:pinfo get -default "" bundle parametersyntax]
+
+
+ [:as_text]
+
+
+
+ [:?var :@method {
+
+ [:for sm [:get_sub_methods] {
+ [$sm render -initscript [list set supermethod [current]] -template submethod]
+ }]
+ } - {
+ [:?var :@parameter {
+
+ Parameters:
+ [:for param [:!get @parameter] {
+
+ [$param print_name]
+ [:? {[$param eval {info exists :spec}] && [$param spec] ne ""} {<[$param spec] >}]
+ [$param as_text]
+ [$param pinfo get -default "" validation]
+ [:? {[$param eval {info exists :default}]} {
+
+ Default Value: [$param default]
+
+ }]
+
+ }]
+
+ }]
+
+ [:?var :@return {
+
+ Returns:
+ [:!let ret [:!get @return]]
+ [:? {[$ret eval {info exists :spec}] && [$ret spec] ne ""} {[$ret spec]}]
+
+
+ [$ret pinfo get -default "" validation]
+ [$ret as_text]
+
+
+ }]
+ }]
+
+ [:? {[:!get @deprecated]} {
+
+ Deprecated
+
+ }]
+
+ [:? {[:!get @syshook] || [:pinfo exists bundle type]} {
+
+ Type:
+ [:pinfo get bundle type] [:? {[:!get @syshook]} {
+
+ internally called, redefinable hook
+ }]
+
+ }]
+
+ [:? {[:pinfo get -default 0 bundle redefine-protected]} {
+
+ Protection:
+ redefine-protected
+
+ }]
+
+
+
+
+
+
+ [:as_text]
+
+
+[:?var :@object-method {
+[:!let omethods [:!get -sortedby name @object-method]]
+
+
Per-Object Methods
+
+
+ [:for om $omethods {
+ [$om name]
+ }]
+
+
+ [:for om $omethods {
+ [$om render]
+ }]
+
+ Object
+ [:print_name -status]
+
+
+[:?var :@see {
+See also: ${:@see}
+}]
+
+
+ [:as_text]
+
+
+[:?var :@object-attribute {
+[:!let obj_attrs [:!get -sortedby name -with name @object-attribute]]
+
+
+
Per-object parameters
+
+
+
+ [:for attr [dict values $obj_attrs] {
+
+ [$attr name]
+
+ }]
+
+
+
+
+
+ [:for attr [dict values $obj_attrs] {
+
+
+
+
+ [:? {[$attr pinfo exists validation]} {
+ [$attr pinfo get validation]
+ }]
+ [$attr as_text]
+
+
+
+
+ [:?objvar $attr default {
+
+ Default Value: $default
+
+ }]
+
+ [:? {[$attr eval {info exists :deprecated}]} {
+
+ Deprecated: [$attr default]
+
+ }]
+
+
+
+ }]
+
+
+
+
+
Per-object methods
+
+
+ [:for m $omethods {
+
+ [$m name]
+
+ }]
+
+
+
+
+ [:for omethod $omethods {
+ [$omethod render]
+ }]
+
+
+
+ [:as_text]
+
+
+[:?var :@require {
+Required packages
+${:@require}
+}]
+
+[:?var :@class {
+Contained classes
+
+}]
+
+[:?var :@object {
+Contained objects
+
+}]
+
+[:?var :@command {
+Contained commands
+
+}]
+
+
Index: library/lib/doc-assets/@package.html.yuidoc
===================================================================
diff -u
--- library/lib/doc-assets/@package.html.yuidoc (revision 0)
+++ library/lib/doc-assets/@package.html.yuidoc (revision 77c371a2e4a1bd85367d11869de6e2dc9fac4771)
@@ -0,0 +1,75 @@
+
+Package: ${:name}
+
+
+
+ [:as_text]
+
+
+
+[:?var :@require {
+
+ Package requires: ${:@require}
+
+} ]
+
+
+
+
+ [:?var :@class {
+
This package contains [llength ${:@class}] classes:
+
+
+ } ]
+
+ [:?var :@object {
+
This package contains [llength ${:@object}] objects:
+
+
+ } ]
+
+
+ [:?var :@command {
+
This package contains [llength ${:@command}] commands:
+
+
+
+ } ]
+
+
+
+
+
+
+
+
[:? {[info exists :@return] && [${:@return} spec] ne ""} {<[${:@return} spec] >} ]
+ obj ${:name} ?value?
+
+
+ [:? {[$owning_attribute pinfo exists validation]} {
+ [$owning_attribute pinfo get validation]
+ }]
+ [$owning_attribute as_text]
+
+
+
+
+ [:? {[$owning_attribute eval {set :@deprecated}]} {
+
+ Deprecated
+
+ }]
+
+
+ Parameters:
+
+ value <optional >
+ If provided, list of values to
+ be set for the attribute ${:name}
+
+
+
+ [:?objvar $owning_attribute @return {
+
+ Returns:
+ [:? {[${:@return} eval {info exists :spec}] && [${:@return} spec] ne ""} {[${:@return} spec]}]
+
+ [${:@return} as_text]
+
+ }]
+
+
+ Type:
+ [:pinfo get bundle type] attribute accessor/mutator
+
+
+
+ Protection:
+ [:? {[:pinfo get -default 0 bundle redefine-protected]} {
+ redefine-protected
+ }]
+
+ [:? {[$owning_attribute pinfo get -default 0 bundle incremental]} {
+
+
+
+
[:? {[info exists :@return] && [${:@return} spec] ne ""} {<[${:@return} spec] >} ]
+ obj
+ ${:name} add
+ value
+
+
+
+ Parameters:
+
+ value <required >
+ ...
+
+
+
+ Returns:
+ The element
+ added to the list
+
+
+
+
+
+
+
+
[:? {[info exists :@return] && [${:@return} spec] ne ""} {<[${:@return} spec] >} ]
+ obj
+ ${:name} delete
+ value
+
+
+
+ Parameters:
+
+ value <required >
+ ...
+
+
+
+ Returns:
+ The element
+ deleted from the the list
+
+
+
+
+
+
+
+
+ [:for entry $entries {
+ [:!let ddesc [$entry as_text]]
+ [:?objvar $entry @acronym {
+ [:!let dtext [$entry @acronym]]
+ [:? {$ddesc ne ""} {
+ [:!let ddesc "[$entry @pretty_name] — $ddesc"]
+ } - {
+ [:!let ddesc "[$entry @pretty_name]"]
+ }]
+
+ } - {
+ [:!let dtext [$entry @pretty_name]]
+ }]
+
+ $dtext
+ $ddesc
+ [:?objvar $entry refs {
+ [:? {[$entry eval [concat dict exists \${:refs} [current]]]} {
+ [:!let refs [sort_by_value [$entry eval [concat dict get \${:refs} [current]]]]]
+
+
+
+ [:for src [dict keys $refs] {
+
+ [$src make_link [current]]
+ ([dict get $refs $src])
+
+ }]
+
+
+
+ }]
+ }]
+ }]
Fisheye: Tag 77c371a2e4a1bd85367d11869de6e2dc9fac4771 refers to a dead (removed) revision in file `library/lib/doc-assets/leftbar.html.tmpl'.
Fisheye: No comparison available. Pass `N' to diff?
Index: library/lib/doc-assets/leftbar.html.yuidoc
===================================================================
diff -u
--- library/lib/doc-assets/leftbar.html.yuidoc (revision 0)
+++ library/lib/doc-assets/leftbar.html.yuidoc (revision 77c371a2e4a1bd85367d11869de6e2dc9fac4771)
@@ -0,0 +1,16 @@
+
+[:for feature [dict keys $owned_parts] {
+
+
[$feature pretty_plural]
+
+ [:for inst [dict get $owned_parts $feature] {
+ [:!let css "" ]
+ [:? {[:info has type [$feature part_class]] && [current] eq $inst} {
+ [:!let css "selected" ]
+ }]
+ [:fit [$inst print_name] 30]
+
+}]
+
$source_anchor
Fisheye: Tag 77c371a2e4a1bd85367d11869de6e2dc9fac4771 refers to a dead (removed) revision in file `library/lib/doc-assets/listing.html.tmpl'.
Fisheye: No comparison available. Pass `N' to diff?
Index: library/lib/doc-assets/listing.html.yuidoc
===================================================================
diff -u
--- library/lib/doc-assets/listing.html.yuidoc (revision 0)
+++ library/lib/doc-assets/listing.html.yuidoc (revision 77c371a2e4a1bd85367d11869de6e2dc9fac4771)
@@ -0,0 +1 @@
+[:? {$inline} {$script} - {$script}]
Fisheye: Tag 77c371a2e4a1bd85367d11869de6e2dc9fac4771 refers to a dead (removed) revision in file `library/lib/doc-assets/method.html.asciidoc'.
Fisheye: No comparison available. Pass `N' to diff?
Fisheye: Tag 77c371a2e4a1bd85367d11869de6e2dc9fac4771 refers to a dead (removed) revision in file `library/lib/doc-assets/method.html.tmpl'.
Fisheye: No comparison available. Pass `N' to diff?
Fisheye: Tag 77c371a2e4a1bd85367d11869de6e2dc9fac4771 refers to a dead (removed) revision in file `library/lib/doc-assets/multifile.html.tmpl'.
Fisheye: No comparison available. Pass `N' to diff?
Index: library/lib/doc-assets/multifile.html.yuidoc
===================================================================
diff -u
--- library/lib/doc-assets/multifile.html.yuidoc (revision 0)
+++ library/lib/doc-assets/multifile.html.yuidoc (revision 77c371a2e4a1bd85367d11869de6e2dc9fac4771)
@@ -0,0 +1,72 @@
+
+
+
+ API: ${:name} [:?var classname {$classname}] [:?var filename {$filename}] (A Next Library)
+
+
+
+
+
${:name}
+ [:? {[:info has type ::nx::doc::@package]} {
+ [:?var :@version {${:@version}} ]
+ } - {
+ [$project version]
+ }]
+
+
[$project name]
+ [:? {[:info has type ::nx::doc::@package]} {
+ >
${:name}
+ } ? {[:info has type ::nx::doc::@class]} {
+ > [:?var :partof {
[${:partof} name] >}] ${:name}
+ }]
+
+
+ [:!let self_owned_parts [[:origin] owned_parts -class ::nx::doc::StructuredEntity]]
+ [:!let owned_parts [dict merge $project_entities $self_owned_parts]]
+
+
+
+ [:? {[:info has type ::nx::doc::@project]} {
+
+ This is the API documentation for the
+
[:name] project.
+
Choose a package, object or command name from the list for more information.
+
+ [:include glossary]
+ } - {
+
+ [:include]
+ }]
+
+
+
+ [:include leftbar]
+
+
+
+
+