Index: doc/Class.man =================================================================== diff -u -r02949079584c317f6d5e6c138d609a66036ac198 -r7944f1c82b2b3f6379fcfa4cf3914df136b6cec9 --- doc/Class.man (.../Class.man) (revision 02949079584c317f6d5e6c138d609a66036ac198) +++ doc/Class.man (.../Class.man) (revision 7944f1c82b2b3f6379fcfa4cf3914df136b6cec9) @@ -1,10 +1,13 @@ [comment {-*- tcl -*- nx::Class manpage}] -[manpage_begin nx::Class n 2.0b6] +[manpage_begin nx::Class 3 2.0b6] -[comment {For the time being, we do not render keywords and the corresponding reverse index}] +[comment {For the time being, we do not render keywords & terms; and +the corresponding reverse index}] [proc keywords args {}] +[proc term v {return $v}] -[keywords base-metaclass] + +[keywords "base metaclass"] [keywords NX] [keywords "mixin class"] [keywords "re-classification"] @@ -18,13 +21,13 @@ [vset CMD "cls"] [vset MODIFIER ""] -[copyright {2014 Stefan Sobernig , Gustaf Neumann }] +[copyright {2014 Stefan Sobernig , Gustaf Neumann ; available under the Creative Commons Attribution 3.0 Austria license (CC BY 3.0 AT).}] [titledesc {API reference of the base-metaclass of the NX objectsystem}] [description] [para] -[cmd nx::Class] is the [term base-metaclass] of the [term NX] object +[cmd nx::Class] is the [term "base metaclass"] of the [term NX] object system. All classes (e.g. [emph cls]) are (direct or indirect) instances of [cmd nx::Class]. Therefore, the methods provided by [cmd nx::Class] are available to all classes. A class [emph cls] which does @@ -207,8 +210,8 @@ [cmd_def info] -A collection of introspection submethods on the structural features (e.g., -configuration options, superclasses) and the behavioral features (e.g., +A collection of introspection submethods on the structural features (e.g. +configuration options, superclasses) and the behavioral features (e.g. methods, [term "filter"]s) provided by [arg cls] to its instances. [list_begin definitions] @@ -298,7 +301,7 @@ }] The factory method will provide computed object names of the form, -e.g., ::nsf::__#0. The uniqueness of generated object names is +e.g. [const ::nsf::__#0]. The uniqueness of generated object names is guaranteed for the scope of the current Tcl interpreter only. [para] @@ -321,7 +324,7 @@ [list_begin definitions] -[call [arg cls] [method property] [opt "[option -accessor] public | protected | private"] [opt "[option -configurable] [arg trueFalse]"] [opt [option -incremental]] [opt "[option -class] [arg className]"] [arg spec] [opt [arg initBlock]]] +[call [arg cls] [method property] [opt "[option -accessor] [const public] | [const protected] | [const private]"] [opt "[option -configurable] [arg trueFalse]"] [opt [option -incremental]] [opt "[option -class] [arg className]"] [arg spec] [opt [arg initBlock]]] [include property.man.inc] @@ -341,7 +344,7 @@ [comment {::nx::Object variable ?-accessor /value/? ?-incremental? ?-class /value/? ?-configurable /boolean/? ?-initblock /value/? ?-nocomplain? /spec/ ?/defaultValue/?}] -[call [arg cls] [method variable] [opt "[option -accessor] public | protected | private"] [opt [option -incremental]] [opt "[option -class] [arg className]"] [opt "[option -configurable] [arg trueFalse]"] [opt "[option -initblock] [arg script]"] [arg spec] [opt [arg defaultValue]]] +[call [arg cls] [method variable] [opt "[option -accessor] [const public] | [const protected] | [const private]"] [opt [option -incremental]] [opt "[option -class] [arg className]"] [opt "[option -configurable] [arg trueFalse]"] [opt "[option -initblock] [arg script]"] [arg spec] [opt [arg defaultValue]]] [include variable.man.inc] @@ -387,13 +390,13 @@ [enum] The newly allocated or recreated object [arg instance] is then configured by dispatching [method configure], provided by [cmd nx::Object], which consumes the configuration options passed into [method create]. This -will establish the instance's initial state, e.g., by setting object +will establish the instance's initial state, e.g. by setting object variables and object relations according to the configuration options and corresponding default values. [enum] Finally, the initialization method [method init] is dispatched, if available for [arg instance]. [method "init"] can be defined by [arg cls] on -behalf of its instance [arg instance], e.g., to lay out a +behalf of its instance [arg instance], e.g. to lay out a class-specific initialisation behaviour. [example_begin] @@ -438,7 +441,7 @@ Recreation is the NX scheme for resolving naming conflicts between objects: An object is requested to be created using [method create] or -[method new] while an object of an identical object name, e.g., [arg instance], already +[method new] while an object of an identical object name, e.g. [arg instance], already exists: [example { @@ -468,7 +471,7 @@ ::Bar % Class create Bar; # calls Bar->destroy() & Class::create(::Bar, ...) }] -[item] An object of an object system other than NX (e.g., XOTcl2) is asked to be recreated. +[item] An object of an object system other than NX (e.g. XOTcl2) is asked to be recreated. [list_end] @@ -481,7 +484,7 @@ Beware that [method __dealloc] does not necessarily cause the object to be deleted immediately. Depending on the lifecycle -of the object's environment (e.g., the Tcl interp interpreter, the containing +of the object's environment (e.g. the Tcl interp interpreter, the containing namespace) and on call references down the callstack, the actual memory freeing/returning operation may occur at a later point. Index: doc/Object.man =================================================================== diff -u -r9594437d3e0d984015f4b0e82f9d96f5ad4266cf -r7944f1c82b2b3f6379fcfa4cf3914df136b6cec9 --- doc/Object.man (.../Object.man) (revision 9594437d3e0d984015f4b0e82f9d96f5ad4266cf) +++ doc/Object.man (.../Object.man) (revision 7944f1c82b2b3f6379fcfa4cf3914df136b6cec9) @@ -1,8 +1,10 @@ [comment {-*- tcl -*- nx::Object manpage}] -[manpage_begin nx::Object n 2.0b6] +[manpage_begin nx::Object 3 2.0b6] -[comment {For the time being, we do not render keywords and the corresponding reverse index}] +[comment {For the time being, we do not render keywords & terms; and +the corresponding reverse index}] [proc keywords args {}] +[proc term v {return $v}] [keywords baseclass] [keywords NX] @@ -16,15 +18,15 @@ [vset CMD "obj"] [vset MODIFIER "object"] -[copyright {2014 Stefan Sobernig , Gustaf Neumann }] +[copyright {2014 Stefan Sobernig , Gustaf Neumann ; available under the Creative Commons Attribution 3.0 Austria license (CC BY 3.0 AT).}] [titledesc {API reference of the base class in the NX object system}] [description] [para] -[syscmd nx::Object] is the [term "base class"] of the [term NX] object system. All +[cmd nx::Object] is the [term "base class"] of the [term NX] object system. All objects defined in [term NX] are (direct or indirect) instances of this -[term "base class"]. The methods provided by the [syscmd nx::Object] +[term "base class"]. The methods provided by the [cmd nx::Object] [term "base class"] are available to all objects and to all classes defined in NX. @@ -69,7 +71,7 @@ instances of [cmd nx::Object]. [para] -Direct instances of nx::Object can be created as follows: +Direct instances of [cmd nx::Object] can be created as follows: [list_begin definitions] @@ -198,7 +200,7 @@ [list_begin definitions] -[call [arg obj] [cmd contains] [opt "-withnew [arg trueFalse]"] [opt "-object [arg objectName]"] [opt "-class [arg className]"] [arg cmds]] +[call [arg obj] [method contains] [opt "-withnew [arg trueFalse]"] [opt "-object [arg objectName]"] [opt "-class [arg className]"] [arg cmds]] This method acts as a builder for nested object structures. Object and class construction statements passed to this method as its last @@ -255,7 +257,7 @@ [list_begin definitions] -[call [arg obj] [cmd copy] [arg newObjectName]] +[call [arg obj] [method copy] [arg newObjectName]] Creates a full and deep copy of a source object [arg obj]. The object's copy [arg newObjectName] features all structural and @@ -301,11 +303,11 @@ [list_begin definitions] -[call [arg obj] [cmd destroy]] +[call [arg obj] [method destroy]] This method allows for explicitly destructing an object [arg obj], potentially prior to [arg obj] being destroyed by the object system -(e.g., during the shutdown of the object system upon calling [syscmd exit]): +(e.g. during the shutdown of the object system upon calling [cmd exit]): [example {[nx::Object new] destroy}] @@ -414,7 +416,7 @@ [list_begin definitions] -[call [arg obj] [method info] [method children] [opt "[option -type] [arg className]"] [opt [arg pattern]]] +[call [arg obj] [method "info children"] [opt "[option -type] [arg className]"] [opt [arg pattern]]] Retrieves the list of nested (or aggregated) objects of [arg obj]. The resulting list contains the fully qualified names of the nested @@ -425,14 +427,14 @@ special matching characters (see [cmd "string match"]). This method allows for introspecting on [method contains]. -[call [arg obj] [method info] [method class]] +[call [arg obj] [method "info class"]] Returns the fully qualified name of the current [cmd nx::Class] of [arg obj]. In case of [term "re-classification"] (see [method configure]), the returned class will be different from the [cmd nx::Class] from which [arg obj] was originally instantiated using [method create] or [method new]. -[call [arg obj] [method info] [method has] [method mixin] | [method namespace] | [method type] [opt "[arg arg] ..."]] +[call [arg obj] [method "info has"] [opt "[method mixin] | [method namespace] | [method type]"] [opt "[arg arg] ..."]] [list_begin definitions] [def "[arg obj] [method "info method has mixin"] [arg className]"] @@ -459,9 +461,9 @@ [call [arg obj] [method "info lookup"] [arg submethod] [opt "[arg arg] ..."]] -A collection of submethods to retrieve structural features (e.g., +A collection of submethods to retrieve structural features (e.g. configuration options, [term "slot object"]s) and behavioral -features (e.g., methods, [term "filter"]s) available for [arg obj] from the perspective of a client to [arg obj]. Features provided by [arg obj] itself and by the classes in its current linearisation list are considered. +features (e.g. methods, [term "filter"]s) available for [arg obj] from the perspective of a client to [arg obj]. Features provided by [arg obj] itself and by the classes in its current linearisation list are considered. [list_begin definitions] [def "[arg obj] [method {info lookup configure parameters}] [opt [arg namePattern]]"] @@ -476,7 +478,7 @@ Returns all configuration options available for [arg obj] as a concrete-syntax description to be used in human-understandable -messages (e.g., errors or warnings, documentation strings). +messages (e.g. errors or warnings, documentation strings). [def "[arg obj] [method "info lookup filter"] [arg name]"] @@ -554,12 +556,12 @@ Returns the fully qualified name of the parent object of [arg obj], if any. If there is no parent object, the name of the Tcl -namespace containing [arg obj] (e.g., "::") will be reported. +namespace containing [arg obj] (e.g. "::") will be reported. [call [arg obj] [method {info precedence}] [opt [option -intrinsic]] [opt [arg pattern]]] -Lists the classes from which [arg obj] inherits structural (e.g., -properties) and behavioral features (e.g., methods) and methods, in +Lists the classes from which [arg obj] inherits structural (e.g. +properties) and behavioral features (e.g. methods) and methods, in order of the [term linearisation] scheme in [term NX]. By setting the [term switch] [option -intrinsic], only classes which participate in superclass/subclass relationships (i.e., intrinsic classes) are @@ -577,7 +579,7 @@ [list_begin itemized] [item] [const name] returns the variable name. [item] [const parameter] returns a canonical parameter specification -eligible to (re-)define the given variable (e.g., using [method "[vset SCOPE] variable"]) in a new context. +eligible to (re-)define the given variable (e.g. using [method "[vset SCOPE] variable"]) in a new context. [item] [const definition] returns a canonical representation of the definition command used to create the variable in its current configuration. [list_end] @@ -661,7 +663,7 @@ [list_begin definitions] -[call [arg obj] [const object] [method property] [opt "[option -accessor] public | protected | private"] [opt "[option -configurable] [arg trueFalse]"] [opt [option -incremental]] [opt "[option -class] [arg className]"] [opt [option -nocomplain]] [arg spec] [opt [arg initBlock]]] +[call [arg obj] [method "object property"] [opt "[option -accessor] [const public] | [const protected] | [const private]"] [opt "[option -configurable] [arg trueFalse]"] [opt [option -incremental]] [opt "[option -class] [arg className]"] [opt [option -nocomplain]] [arg spec] [opt [arg initBlock]]] [include property.man.inc] @@ -693,7 +695,7 @@ [list_begin definitions] -[call [arg obj] [method require] [method namespace]] +[call [arg obj] [method "require namespace"]] Create a Tcl namespace named after the object [arg obj]. All object variables become available as namespace variables. @@ -706,7 +708,7 @@ [list_begin definitions] -[call [arg obj] [cmd unknown] [arg unknownMethodName] [opt "[arg arg] ..."]] +[call [arg obj] [method unknown] [arg unknownMethodName] [opt "[arg arg] ..."]] This method is called implicitly whenever an unknown method is invoked. @@ -722,7 +724,7 @@ [comment {::nx::Object variable ?-accessor /value/? ?-incremental? ?-class /value/? ?-configurable /boolean/? ?-initblock /value/? ?-nocomplain? /spec/ ?/defaultValue/?}] -[call [arg obj] [const object] [method variable] [opt "[option -accessor] public | protected | private"] [opt [option -incremental]] [opt "[option -class] [arg className]"] [opt "[option -configurable] [arg trueFalse]"] [opt "[option -initblock] [arg script]"] [opt [option -nocomplain]] [arg spec] [opt [arg defaultValue]]] +[call [arg obj] [method "object variable"] [opt "[option -accessor] [const public] | [const protected] | [const private]"] [opt [option -incremental]] [opt "[option -class] [arg className]"] [opt "[option -configurable] [arg trueFalse]"] [opt "[option -initblock] [arg script]"] [opt [option -nocomplain]] [arg spec] [opt [arg defaultValue]]] [include variable.man.inc] @@ -788,12 +790,12 @@ [enum] As a [emph placeholder] for the currently active object, [cmd nx::current] can be used to retrieve the object name. [enum] Reading and writing [emph "object variables"] directly (i.e. without getter/setter methods in place) require the use -of variable names carrying the prefix ":" ("colon-prefix +of variable names carrying the prefix [const :] ("colon-prefix notation"). Internally, colon-prefixed variable names are processed using Tcl's variable resolvers. Alternatively, one can provide for getter/setter methods for object variables (see [method property] and [method variable]). [enum] [emph {Self-referential method calls}] can be defined via -prefixing (":") the method names or, alternatively, via [cmd nx::current]. Internally, +prefixing ([const :]) the method names or, alternatively, via [cmd nx::current]. Internally, colon-prefixed method names are processed using Tcl's command resolvers. The colon-prefix notation is recommended, also because it has a (slight) performance advantage over [cmd nx::current] which Index: doc/alias.man.inc =================================================================== diff -u -r9594437d3e0d984015f4b0e82f9d96f5ad4266cf -r7944f1c82b2b3f6379fcfa4cf3914df136b6cec9 --- doc/alias.man.inc (.../alias.man.inc) (revision 9594437d3e0d984015f4b0e82f9d96f5ad4266cf) +++ doc/alias.man.inc (.../alias.man.inc) (revision 7944f1c82b2b3f6379fcfa4cf3914df136b6cec9) @@ -4,7 +4,7 @@ [keywords "value checker"] [keywords "method handle"] -[call [arg [vset CMD]] [opt "public | private | protected"] [const [vset MODIFIER]] [cmd alias] [arg methodName] [opt "[option -returns] [arg valueChecker]"] [opt "[option -frame] object | method"] [arg cmdName]] +[call [arg [vset CMD]] [opt "[method public] | [method private] | [method protected]"] [method "[vset MODIFIER] alias"] [arg methodName] [opt "[option -returns] [arg valueChecker]"] [opt "[option -frame] [const object] | [const method]"] [arg cmdName]] Define an [term "alias method"] for the given [vset SCOPE]. The resulting method registers a pre-existing Tcl command [arg cmdName] Index: doc/configure.man =================================================================== diff -u -r4fa91fd71b8ea8ecae4c3ead3a13c53e6e7aab62 -r7944f1c82b2b3f6379fcfa4cf3914df136b6cec9 --- doc/configure.man (.../configure.man) (revision 4fa91fd71b8ea8ecae4c3ead3a13c53e6e7aab62) +++ doc/configure.man (.../configure.man) (revision 7944f1c82b2b3f6379fcfa4cf3914df136b6cec9) @@ -1,8 +1,8 @@ [comment {-*- tcl -*- nx::configure manpage}] -[manpage_begin nx::configure n 2.0b6] +[manpage_begin nx::configure 3 2.0b6] -[copyright { 2014 Stefan Sobernig , Gustaf Neumann }] +[copyright { 2014 Stefan Sobernig , Gustaf Neumann ; available under the Creative Commons Attribution 3.0 Austria license (CC BY 3.0 AT).}] [titledesc {Get and set configuration options on the object system}] Index: doc/current.man =================================================================== diff -u -r79fbeda2dd283936b2ec9ca6636037867c1c1f4d -r7944f1c82b2b3f6379fcfa4cf3914df136b6cec9 --- doc/current.man (.../current.man) (revision 79fbeda2dd283936b2ec9ca6636037867c1c1f4d) +++ doc/current.man (.../current.man) (revision 7944f1c82b2b3f6379fcfa4cf3914df136b6cec9) @@ -1,8 +1,8 @@ [comment {-*- tcl -*- nx::current manpage}] -[manpage_begin nx::current n 2.0b6] +[manpage_begin nx::current 3 2.0b6] -[copyright { 2014 Stefan Sobernig , Gustaf Neumann }] +[copyright { 2014 Stefan Sobernig , Gustaf Neumann ; available under the Creative Commons Attribution 3.0 Austria license (CC BY 3.0 AT).}] [titledesc {Return information about the method callstack}] @@ -15,7 +15,7 @@ This introspection command provides information about various details, to be identified using [arg option], on the callstack. The command is invoked from a method body. If [arg option] is not provided, [cmd nx::current] will -default to option [option "object"]. [cmd nx::current] operates on the +default to option [option "object"] (see below). [cmd nx::current] operates on the Tcl callstack and is aware of NX-specific callstack and stackframe details. [arg option] can be any of the following: @@ -27,7 +27,7 @@ calls into the currently executing method directly. This [option "activelevel"] might correspond the [option "callinglevel"], but this is not necessarily the case. The [option "activelevel"] also includes -intermediate calls, such [cmd nx::next] invocations. The level is +intermediate calls, such as [cmd nx::next] invocations. The level is reported as an absolute level number (# followed by a digit) to be directly used as the first argument to [cmd uplevel] or [cmd upvar]. @@ -46,11 +46,11 @@ provides the method implementation calling into the currently executing method. See also [option "callingobject"]. -[item] [option "callinglevel"] resolves the callstack level of the the +[item] [option "callinglevel"] resolves the callstack level of the originating invocation of the currently executing method implementation. Callstack levels introduced by method interception (e.g., filters) and by method combination ([cmd nx::next]) are -ignored. The level is reported as an absolute level number (# followed +ignored. The level is reported as an absolute level number ([const #] followed by a digit) to be directly used as the first argument to [cmd uplevel] or [cmd upvar]. See also [option "activelevel"]. Index: doc/delete.man.inc =================================================================== diff -u -re5ad7edaed3418723ed31bda80c8639df6b44a7e -r7944f1c82b2b3f6379fcfa4cf3914df136b6cec9 --- doc/delete.man.inc (.../delete.man.inc) (revision e5ad7edaed3418723ed31bda80c8639df6b44a7e) +++ doc/delete.man.inc (.../delete.man.inc) (revision 7944f1c82b2b3f6379fcfa4cf3914df136b6cec9) @@ -3,18 +3,18 @@ [keywords "alias method"] [keywords "forwarder method"] -[call [arg [vset CMD]] [method delete] [const [vset MODIFIER]] [method property]|[method variable]|[method method] [arg arg]] +[call [arg [vset CMD]] [method [string trim "delete [vset MODIFIER]"]] [arg feature] [arg arg]] This method serves as the equivalent to Tcl's [cmd rename] for removing structural (properties, variables) and behavioral features (methods) of the [vset SCOPE]: -[def "[arg [vset CMD]] [method delete] [const [vset MODIFIER]] [const property] [arg propertyName]"] -[def "[arg [vset CMD]] [method delete] [const [vset MODIFIER]] [const variable] [arg variableName]"] -[def "[arg [vset CMD]] [method delete] [const [vset MODIFIER]] [const method] [arg methodName]"] +[def "[arg [vset CMD]] [method "delete [vset MODIFIER] property"] [arg propertyName]"] +[def "[arg [vset CMD]] [method "delete [vset MODIFIER] variable"] [arg variableName]"] +[def "[arg [vset CMD]] [method "delete [vset MODIFIER] method"] [arg methodName]"] Removes a property [arg propertyName], variable [arg variableName], -and method [arg methodNome], respectively, previously defined for the +and method [arg methodName], respectively, previously defined for the scope of the [vset SCOPE]. [para] -[method "delete [const [vset MODIFIER]] [const method]"] can be equally used for removing regular methods (see [method "[vset MODIFIER] method"]), an [term "alias method"] (see [method "[vset MODIFIER] alias"]), and a [term "forwarder method"] (see [method "[vset MODIFIER] forward"]). +[method "delete [vset MODIFIER] method"] can be equally used for removing regular methods (see [method "[vset MODIFIER] method"]), an [term "alias method"] (see [method "[vset MODIFIER] alias"]), and a [term "forwarder method"] (see [method "[vset MODIFIER] forward"]). Index: doc/forward.man.inc =================================================================== diff -u -r02949079584c317f6d5e6c138d609a66036ac198 -r7944f1c82b2b3f6379fcfa4cf3914df136b6cec9 --- doc/forward.man.inc (.../forward.man.inc) (revision 02949079584c317f6d5e6c138d609a66036ac198) +++ doc/forward.man.inc (.../forward.man.inc) (revision 7944f1c82b2b3f6379fcfa4cf3914df136b6cec9) @@ -4,7 +4,7 @@ [keywords "forward method"] [keywords "debugging level"] -[call [arg [vset CMD]] [opt "public | protected | private"] [const [vset MODIFIER]] [method forward] [arg methodName] [opt "[option -prefix] [arg prefixName]"] [opt "[option -frame] [arg object]"] [opt "[option -returns] [arg valueChecker]"] [opt [option -verbose]] [opt [arg target]] [opt "[arg arg] ..."]] +[call [arg [vset CMD]] [opt "[method public] | [method protected] | [method private]"] [method "[vset MODIFIER] forward"] [arg methodName] [opt "[option -prefix] [arg prefixName]"] [opt "[option -frame] [const object]"] [opt "[option -returns] [arg valueChecker]"] [opt [option -verbose]] [opt [arg target]] [opt "[arg arg] ..."]] Define a [term "forward method"] for the given [vset SCOPE]. The definition of a [term "forward method"] registers a predefined, but @@ -28,7 +28,7 @@ As for a regular [method "[vset MODIFIER] method"], [option "-returns"] allows for setting a [term "value checker"] on the values returned by the -resulting Tcl command call. When passing to [option "-frame"] [const object], the +resulting Tcl command call. When passing [const object] to [option "-frame"], the resulting Tcl command is evaluated in the context of the object receiving the [term "forward method"] call. This way, variable names used in the resulting execution of a command become resolved as Index: doc/info.man.inc =================================================================== diff -u -r02949079584c317f6d5e6c138d609a66036ac198 -r7944f1c82b2b3f6379fcfa4cf3914df136b6cec9 --- doc/info.man.inc (.../info.man.inc) (revision 02949079584c317f6d5e6c138d609a66036ac198) +++ doc/info.man.inc (.../info.man.inc) (revision 7944f1c82b2b3f6379fcfa4cf3914df136b6cec9) @@ -83,7 +83,7 @@ [para] -By setting [option -callprotection], only methods of a certain [term "call protection"] [arg level] ([term "public"], [term "protected"], or [term "private"]) will be returned. Methods of a specific type can be requested using [option "-type"]. The recognized values for [arg methodType] are: +By setting [option -callprotection], only methods of a certain [term "call protection"] [arg level] ([const "public"], [const "protected"], or [const "private"]) will be returned. Methods of a specific type can be requested using [option "-type"]. The recognized values for [arg methodType] are: [list_begin itemized] [item] [const scripted] denotes methods defined using [const [vset SCOPE]] [method method]; [item] [const alias] denotes [term "alias method"]s defined using [const [vset SCOPE]] [method alias]; Index: doc/man.css =================================================================== diff -u -r157136a6920b5583b1b3d30257af9f8d3f54c0d0 -r7944f1c82b2b3f6379fcfa4cf3914df136b6cec9 --- doc/man.css (.../man.css) (revision 157136a6920b5583b1b3d30257af9f8d3f54c0d0) +++ doc/man.css (.../man.css) (revision 7944f1c82b2b3f6379fcfa4cf3914df136b6cec9) @@ -115,7 +115,7 @@ font-weight: bold; } -dl.definitions i.arg { +dl.definitions i.arg, dl.options i.arg { background: none repeat scroll 0 0 #ffffff; border: 1px solid #efeeed; padding: 0 3px; @@ -125,7 +125,7 @@ font-weight: normal; } -dl.definitions b.option { +dl.definitions b.option, dl.options b.option { background: none repeat scroll 0 0 #ffffff; border: 1px solid #efeeed; padding: 0 3px; @@ -136,7 +136,7 @@ text-decoration: none; } -p b.cmd { +dl.definitions b.cmd, p b.cmd { background: none repeat scroll 0 0 #e7edd3; border: 1px solid #89a618; padding: 0 3px; @@ -146,7 +146,18 @@ font-weight: bold; } +dl.definitions b.const, p b.const { + /* background: none repeat scroll 0 0 #ffffff; */ + /* border: 1px solid #efeeed; */ + padding: 0 3px; + font-family: Menlo,Monaco,"DejaVu Sans Mono","Bitstream Vera Sans Mono","Courier New",Courier,monospace; + font-size: 92.308%; + line-height: 1.35; + font-weight: normal; + text-decoration: none; +} + code, kbd, pre, samp { font-family: Menlo,Monaco,"DejaVu Sans Mono","Bitstream Vera Sans Mono","Courier New",Courier,monospace; font-size: 92.308%; Index: doc/method.man.inc =================================================================== diff -u -r02949079584c317f6d5e6c138d609a66036ac198 -r7944f1c82b2b3f6379fcfa4cf3914df136b6cec9 --- doc/method.man.inc (.../method.man.inc) (revision 02949079584c317f6d5e6c138d609a66036ac198) +++ doc/method.man.inc (.../method.man.inc) (revision 7944f1c82b2b3f6379fcfa4cf3914df136b6cec9) @@ -1,6 +1,6 @@ [comment {-*- tcl -*- manpage fragment for method method, shared by nx::Object and nx::Class}] -[call [arg [vset CMD]] [opt "public | protected | private"] [const [vset MODIFIER]] [method method] [arg name] [arg parameters] [opt [option "-checkalways"]] [opt "[option -returns] [arg valueChecker]"] [arg body]] +[call [arg [vset CMD]] [opt "[method public] | [method protected] | [method private]"] [method "[vset MODIFIER] method"] [arg name] [arg parameters] [opt [option "-checkalways"]] [opt "[option -returns] [arg valueChecker]"] [arg body]] [keywords "value checker"] [keywords "colon-prefix notation"] Index: doc/mixin.man.inc =================================================================== diff -u -r02949079584c317f6d5e6c138d609a66036ac198 -r7944f1c82b2b3f6379fcfa4cf3914df136b6cec9 --- doc/mixin.man.inc (.../mixin.man.inc) (revision 02949079584c317f6d5e6c138d609a66036ac198) +++ doc/mixin.man.inc (.../mixin.man.inc) (revision 7944f1c82b2b3f6379fcfa4cf3914df136b6cec9) @@ -3,7 +3,7 @@ [keywords "mixin class"] [keywords linearisation] -[call [arg [vset CMD]] [const [vset MODIFIER]] [method mixins] [arg submethod] [opt "[arg arg] ..."]] +[call [arg [vset CMD]] [method "[vset MODIFIER] mixins"] [arg submethod] [opt "[arg arg] ..."]] Accesses and modifies the list of [term "mixin class"]es of [arg [vset CMD]] using a specific setter or getter [arg submethod]: Index: doc/next.man =================================================================== diff -u -r2d52e841337e89ec624790846ca562d8f2deb0c4 -r7944f1c82b2b3f6379fcfa4cf3914df136b6cec9 --- doc/next.man (.../next.man) (revision 2d52e841337e89ec624790846ca562d8f2deb0c4) +++ doc/next.man (.../next.man) (revision 7944f1c82b2b3f6379fcfa4cf3914df136b6cec9) @@ -1,5 +1,5 @@ [comment {-*- tcl -*- nx::next manpage}] -[manpage_begin nx::next n 2.0b6] +[manpage_begin nx::next 3 2.0b6] [copyright {2014 Stefan Sobernig , Gustaf Neumann }] [titledesc {Skip to the next most specific method implementation}] @@ -14,7 +14,7 @@ specific method implementation in the list of available methods. This list of available methods is specific to the current method-call context. This context is set by the usage context of [cmd nx::next] -(method combination vs. method interception; see below). The optional +(method combination vs. method-call interception; see below). The optional [arg "arguments"] are the argument values to be passed into the next most specific method implementation. If omitted, the arguments of the current method call are automatically forwarded. To call the next most @@ -26,25 +26,25 @@ If there are no more further applicable methods, the result of [cmd nx::next] will depend on its usage context: method combination or -method interception. If [cmd nx::next] is used in a method body for +method-call interception. If [cmd nx::next] is used in a method body for method combination, the result will be an empty string. If [cmd nx::next] is -used in the body of a filter method for method interception, the +used in the body of a filter method for method-call interception, the result will be an error. [para] When executing a method call, the NX dispatch mechanism computes a list of applicable method implementations for the method name requested from a given object receiving the call; in support of method -combination and method interception. +combination and method-call interception. [para] For [emph "method combination"], the computed list contains any object-local method implementation and any method implementations inherited by the object from the classes in its precedence list. Examples are overloading method implementations in the class hierarchy of the -object, as well as from mixin classes of the object. For [emph "method interception"], +object, as well as from mixin classes of the object. For [emph "method-call interception"], the computed list contains the applicable filter methods, again ordered by their definition order according to the precedence list of the called object. Index: doc/nxsh.man =================================================================== diff -u -r52a0baf40df0884a1568900e719997f2dbc51287 -r7944f1c82b2b3f6379fcfa4cf3914df136b6cec9 --- doc/nxsh.man (.../nxsh.man) (revision 52a0baf40df0884a1568900e719997f2dbc51287) +++ doc/nxsh.man (.../nxsh.man) (revision 7944f1c82b2b3f6379fcfa4cf3914df136b6cec9) @@ -2,7 +2,7 @@ [manpage_begin nxsh 1 2.0b6] -[copyright { 2014 Stefan Sobernig , Gustaf Neumann }] +[copyright {2014 Stefan Sobernig , Gustaf Neumann ; available under the Creative Commons Attribution 3.0 Austria license (CC BY 3.0 AT).}] [titledesc {Simple shell containing NSF/NX interpreter}] Index: doc/nxwish.man =================================================================== diff -u -r52a0baf40df0884a1568900e719997f2dbc51287 -r7944f1c82b2b3f6379fcfa4cf3914df136b6cec9 --- doc/nxwish.man (.../nxwish.man) (revision 52a0baf40df0884a1568900e719997f2dbc51287) +++ doc/nxwish.man (.../nxwish.man) (revision 7944f1c82b2b3f6379fcfa4cf3914df136b6cec9) @@ -2,7 +2,7 @@ [manpage_begin nxwish 1 2.0b6] -[copyright { 2014 Stefan Sobernig , Gustaf Neumann }] +[copyright {2014 Stefan Sobernig , Gustaf Neumann ; available under the Creative Commons Attribution 3.0 Austria license (CC BY 3.0 AT).}] [titledesc {Simple windowing shell containing NSF/NX interpreter}] Index: doc/property.man.inc =================================================================== diff -u -r02949079584c317f6d5e6c138d609a66036ac198 -r7944f1c82b2b3f6379fcfa4cf3914df136b6cec9 --- doc/property.man.inc (.../property.man.inc) (revision 02949079584c317f6d5e6c138d609a66036ac198) +++ doc/property.man.inc (.../property.man.inc) (revision 7944f1c82b2b3f6379fcfa4cf3914df136b6cec9) @@ -18,12 +18,12 @@ Defines a [term property] for the scope of the [vset SCOPE]. The [arg spec] provides the [term property] specification as a [cmd list] holding at least one element or, maximum, two elements: -[emph propertyName][opt ":[emph typeSpec]"] [opt [emph defaultValue]]. The [arg propertyName] is also used as to form the names of the getter/setter methods, +[arg propertyName][opt "[const :][arg typeSpec]"] [opt [arg defaultValue]]. The [arg propertyName] is also used as to form the names of the getter/setter methods, if requested (see [option "-accessor"]). It -is, optionally, equipped with a [emph typeSpec] following a colon +is, optionally, equipped with a [arg typeSpec] following a colon delimiter which specifies a [term "value checker"] for the values which become assigned to the property. The second, optional element -sets a [emph defaultValue] for this property. +sets a [arg defaultValue] for this property. [para] @@ -38,16 +38,16 @@ Removes the value store of [arg propertyName] (e.g., an object variable), if existing. [list_end] The option value passed along [option "-accessor"] sets the level of -[term "call protection"] for the generated getter and setter methods: [term public], -[term protected], or [term private]. By default, no getter and setter +[term "call protection"] for the generated getter and setter methods: [const public], +[const protected], or [const private]. By default, no getter and setter methods are created. [para] Turning on the [term switch] [option -incremental] provides a refined setter interface to the value managed by the [term property]. First, setting [option -incremental] implies requesting [option -accessor] -(set to [emph public] by default, if not specified +(set to [const public] by default, if not specified explicitly). Second, the managed value will be considered a valid Tcl list. A [term multiplicity] of [const 1..*] is set by default, if not specified explicitly as part of [arg spec]. Third, to Index: doc/require.man.inc =================================================================== diff -u -r54cdf1847245e3d6245a740808d1d6923fb78997 -r7944f1c82b2b3f6379fcfa4cf3914df136b6cec9 --- doc/require.man.inc (.../require.man.inc) (revision 54cdf1847245e3d6245a740808d1d6923fb78997) +++ doc/require.man.inc (.../require.man.inc) (revision 7944f1c82b2b3f6379fcfa4cf3914df136b6cec9) @@ -2,7 +2,7 @@ [keywords "call protection"] -[call [arg [vset CMD]] [method require] [opt "public | protected | private"] [const [vset MODIFIER]] [method method] [arg methodName]] +[call [arg [vset CMD]] [method require] [opt "[method public] | [method protected] | [method private]"] [method "[vset MODIFIER] method"] [arg methodName]] Attempts to register a method definition made available using [cmd ::nsf::method::provide] under the name [arg methodName] with [arg [vset CMD]] . The registered Index: doc/variable.man.inc =================================================================== diff -u -r2eb328e4d7f6cb4f21144efdb08c87742d0a44f5 -r7944f1c82b2b3f6379fcfa4cf3914df136b6cec9 --- doc/variable.man.inc (.../variable.man.inc) (revision 2eb328e4d7f6cb4f21144efdb08c87742d0a44f5) +++ doc/variable.man.inc (.../variable.man.inc) (revision 7944f1c82b2b3f6379fcfa4cf3914df136b6cec9) @@ -8,7 +8,7 @@ }] Defines a [term variable] for the scope of the [vset SCOPE]. The [arg spec] provides -the [term variable] specification: [arg variableName][opt ":[emph typeSpec]"]. The +the [term variable] specification: [arg variableName][opt "[const :][arg typeSpec]"]. The [arg variableName] will be used to name the underlying Tcl variable and the getter/setter methods, if requested (see [option "-accessor"]). [arg spec] is optionally equipped with a [arg typeSpec] following a colon @@ -31,16 +31,16 @@ [list_end] The option value passed along [option "-accessor"] sets the level of -[term "call protection"] for the getter and setter methods: [term public], -[term protected], or [term private]. By default, no getter and setter +[term "call protection"] for the getter and setter methods: [const public], +[const protected], or [const private]. By default, no getter and setter methods are created. [para] Turning on the [term switch] [option -incremental] provides a refined setter interface to the value managed by the [term variable]. First, setting [option -incremental] implies requesting [option -accessor] -([emph public] by default, if not specified +([const public] by default, if not specified explicitly). Second, the managed value will be considered a valid Tcl list. A [term multiplicity] of [const 1..*] is set by default, if not specified explicitly as part of [arg spec] (see above). Third, to @@ -75,7 +75,7 @@ [item] [option -configurable] equals [const true]. [item] [option -accessor] is one of [const public], [const protected], or [const private]. [item] [option -incremental] is turned on. -[item] [option -initblock] is not assigned an empty string. +[item] [option -initblock] is a non-empty string. [list_end] Provided a [term "slot object"] managing the [term variable] is to be Index: doc/xotclsh.man =================================================================== diff -u -r52a0baf40df0884a1568900e719997f2dbc51287 -r7944f1c82b2b3f6379fcfa4cf3914df136b6cec9 --- doc/xotclsh.man (.../xotclsh.man) (revision 52a0baf40df0884a1568900e719997f2dbc51287) +++ doc/xotclsh.man (.../xotclsh.man) (revision 7944f1c82b2b3f6379fcfa4cf3914df136b6cec9) @@ -2,7 +2,7 @@ [manpage_begin xotclsh 1 2.0b6] -[copyright { 2014 Stefan Sobernig , Gustaf Neumann }] +[copyright {2014 Stefan Sobernig , Gustaf Neumann ; available under the Creative Commons Attribution 3.0 Austria license (CC BY 3.0 AT).}] [titledesc {Simple shell containing NSF/XOTcl2 interpreter}] Index: doc/xowish.man =================================================================== diff -u -r52a0baf40df0884a1568900e719997f2dbc51287 -r7944f1c82b2b3f6379fcfa4cf3914df136b6cec9 --- doc/xowish.man (.../xowish.man) (revision 52a0baf40df0884a1568900e719997f2dbc51287) +++ doc/xowish.man (.../xowish.man) (revision 7944f1c82b2b3f6379fcfa4cf3914df136b6cec9) @@ -2,7 +2,7 @@ [manpage_begin xowish 1 2.0b6] -[copyright { 2014 Stefan Sobernig , Gustaf Neumann }] +[copyright { 2014 Stefan Sobernig , Gustaf Neumann ; available under the Creative Commons Attribution 3.0 Austria license (CC BY 3.0 AT).}] [titledesc {Simple windowing shell containing NSF/XOTcl2 interpreter}]