Index: generic/predefined.tcl =================================================================== diff -u -r6458c13882afd52e8719ee0e0e054b42e9aee696 -re29308a6c15da697df375716a3ae3787ade64218 --- generic/predefined.tcl (.../predefined.tcl) (revision 6458c13882afd52e8719ee0e0e054b42e9aee696) +++ generic/predefined.tcl (.../predefined.tcl) (revision e29308a6c15da697df375716a3ae3787ade64218) @@ -20,7 +20,8 @@ # @param object:object # @param -per-object:switch # @param methodName - # @param methodproperty Accepts one of: {{{protected}}}, {{{redefine-protected}}}, {{{returns}}}, {{{slotobj}}} + # @param methodproperty Accepts one of: {{{protected}}}, + # {{{redefine-protected}}}, {{{returns}}}, {{{slotobj}}} # @param value # @command setter @@ -51,7 +52,8 @@ # @command objectproperty # # @param object:object - # @param objectkind Accepts one of: {{{type}}}, {{{object}}}, {{{class}}}, {{{baseclass}}}, {{{metaclass}}}, {{{hasmixin}}} + # @param objectkind Accepts one of: {{{type}}}, {{{object}}}, + # {{{class}}}, {{{baseclass}}}, {{{metaclass}}}, {{{hasmixin}}} # @param value:optional # @command importvar @@ -125,17 +127,50 @@ # It comes with a variety of subcommands to query different bits of # callstack information. See below. # - # @subcommand class Returns the name of the class holding the currently executing per-class method, if and only if called from within a per-class method. Note, that this method-owning class may be different to the class of the current object. If called from within a per-object method, it returns an empty string. + # @subcommand class Returns the name of the class holding the + # currently executing per-class method, if and only if called from + # within a per-class method. Note, that this method-owning class may + # be different to the class of the current object. If called from + # within a per-object method, it returns an empty string. + # # @subcommand proc Returns the name of the currently executing method. - # @subcommand callingclass Returns the name of the class which is calling into the executing method. - # @subcommand callingobject Returns the name of the object which is calling into the executing method. - # @subcommand calledclass Returns the name of the class that holds the originally (and now shadowed) target method (applicable in mixin classes and filters). - # @subcommand calledproc Returns the name of the target method (applicable in a filter only). - # @subcommand isnextcall Returns 1 if the executing method was invoked via {{@command ::nx::next}}, 0 otherwise. - # @subcommand next Returns the name of the method next on the precedence path as a string. - # @subcommand filterreg In a method serving as active filter, returns the name of the object (class) on which the method is registered as a filter. - # @subcommand callinglevel Returns the "original" callstack level calling into the executing method. Intermediary {{{next}}} calls are ignored in this computation. The level is returned in a form so that it can be used as first argument in {{@method ::nx::Object class uplevel}} or {{@method ::nx::Object class upvar}}. - # @subcommand activelevel Returns the actual callstack level calling into the executing method. The active might correspond the {{{callinglevel}}}, but this is not necessarily the case. The {{{activelevel}}} counts {{@command ::nx::next}} call. The level is returned in a form so that it can be used as first argument in {{@method ::nx::Object class uplevel}} or {{@method ::nx::Object class upvar}}. + # + # @subcommand callingclass Returns the name of the class which is + # calling into the executing method. + # + # @subcommand callingobject Returns the name of the object which is + # calling into the executing method. + # + # @subcommand calledclass Returns the name of the class that holds + # the originally (and now shadowed) target method (applicable in + # mixin classes and filters). + # + # @subcommand calledproc Returns the name of the target method + # (applicable in a filter only). + # + # @subcommand isnextcall Returns 1 if the executing method was + # invoked via {{@command ::nx::next}}, 0 otherwise. + # + # @subcommand next Returns the name of the method next on the + # precedence path as a string. + # + # @subcommand filterreg In a method serving as active filter, + # returns the name of the object (class) on which the method is + # registered as a filter. + # + # @subcommand callinglevel Returns the "original" callstack level + # calling into the executing method. Intermediary {{{next}}} calls + # are ignored in this computation. The level is returned in a form + # so that it can be used as first argument in {{@method ::nx::Object + # class uplevel}} or {{@method ::nx::Object class upvar}}. + # + # @subcommand activelevel Returns the actual callstack level calling + # into the executing method. The active might correspond the + # {{{callinglevel}}}, but this is not necessarily the case. The + # {{{activelevel}}} counts {{@command ::nx::next}} call. The level + # is returned in a form so that it can be used as first argument in + # {{@method ::nx::Object class uplevel}} or {{@method ::nx::Object + # class upvar}}. namespace export next current # Symbols reused in XOTcl @@ -146,7 +181,7 @@ # properties of the "Next" object system for the scope of an entire # {{{interp}}}. - # @subcommand configure#filter + # @command.subcommand {configure filter} # # Allows turning on or off filters globally for the current # interpreter. By default, the filter state is turned off. This @@ -157,7 +192,7 @@ # @param toggle Accepts either "on" or "off" # @return The current filter activation state - # @subcommand configure#softrecreate + # @command.subcommand {configure softrecreate} # # Allows controlling the scheme applied when recreating an object or a # class. By default, it is set to {{{off}}}. This means that the @@ -181,7 +216,7 @@ # @return The current toggle value - # @subcommand configure#objectsystems + # @command.subcommand {configure objectsystems} # # A mere introspection subcommand. It gives you the top level of the # current object system, i.e., the ruling root class and root @@ -193,7 +228,7 @@ # # @return The active pair of root class and root meta-class - # @subcommand configure#keepinitcmd + # @command.subcommand {configure keepinitcmd} # # Usually, initcmd scripts are discarded by the {{{interp}}} once # having been evaluated (in contrast to {{{proc}}} and {{{method}}} @@ -208,8 +243,13 @@ # @command alias # - # @param object:object The target object which becomes the owner of the aliased command (method, object or command). - # @param -per-object:switch If the target object is a class, one can specify the binding scope (i.e., per-object or per-class) of the aliased command + # @param object:object The target object which becomes the owner of + # the aliased command (method, object or command). + # + # @param -per-object:switch If the target object is a class, one can + # specify the binding scope (i.e., per-object or per-class) of the + # aliased command + # # @param methodName The name of the alias. # @param -nonleaf:switch ... # @param -objscope:switch ...