From: <eri...@us...> - 2017-03-31 13:05:19
|
Revision: 11220 http://sourceforge.net/p/oorexx/code-0/11220 Author: erich_st Date: 2017-03-31 13:05:16 +0000 (Fri, 31 Mar 2017) Log Message: ----------- rexxref changes for [bugs:#1300] 'Object RUN, SETMETHOD, and UNSETMETHOD no longer real private'; other typos and minor changes Modified Paths: -------------- docs/trunk/rexxref/en-US/collclasses.xml docs/trunk/rexxref/en-US/fundclasses.xml docs/trunk/rexxref/en-US/intro.xml docs/trunk/rexxref/en-US/provide.xml Modified: docs/trunk/rexxref/en-US/collclasses.xml =================================================================== --- docs/trunk/rexxref/en-US/collclasses.xml 2017-03-13 21:02:50 UTC (rev 11219) +++ docs/trunk/rexxref/en-US/collclasses.xml 2017-03-31 13:05:16 UTC (rev 11220) @@ -5124,7 +5124,7 @@ <para>Returns the item located at <emphasis role="italic">index</emphasis>. This method is the same as the -<xref linkend="mthListAt" xrefstyle="template:at method:title"/>.</para> +<xref linkend="mthListAt" xrefstyle="select:title"/> method.</para> </section> <section id="mthListPutSet"><title>[]=</title> @@ -5142,7 +5142,7 @@ <para>Replaces the item at <emphasis role="italic">index</emphasis> with <emphasis role="italic">item</emphasis>. This method is the same as the -<xref linkend="mthListPut" xrefstyle="template:put method:title"/>.</para> +<xref linkend="mthListPut" xrefstyle="select:title"/> method.</para> </section> <section id="mthListAllIndexes"><title>allIndexes</title> Modified: docs/trunk/rexxref/en-US/fundclasses.xml =================================================================== --- docs/trunk/rexxref/en-US/fundclasses.xml 2017-03-13 21:02:50 UTC (rev 11219) +++ docs/trunk/rexxref/en-US/fundclasses.xml 2017-03-31 13:05:16 UTC (rev 11220) @@ -1207,13 +1207,16 @@ second item is a class object to use as the starting point for the method search. </para> -<para>If you specify neither Individual nor Array, the message sent has no -arguments. </para> -<para>If you specify the Individual or Array option, any remaining arguments -are arguments for the message. (You need to specify only the first letter; -all characters following the first are ignored.) </para> +<para>If you specify neither <option>Individual</option> nor <option>Array</option>, +the message sent has no arguments. +</para> +<para>If you specify the <option>Individual</option> or <option>Array</option> option, +any remaining arguments are arguments for the message. +(You need to specify only the first letter; +all characters following the first are ignored.) +</para> <variablelist> -<varlistentry><term>Individual</term> +<varlistentry><term><option>Individual</option></term> <listitem><para>If you specify this option, specifying <emphasis role="italic">argument</emphasis> is optional. Any <emphasis role="italic">argument</emphasis>s @@ -1220,7 +1223,7 @@ are passed as message arguments to <emphasis role="italic">target</emphasis> in the order you specify them. </para></listitem></varlistentry> -<varlistentry><term>Array</term> +<varlistentry><term><option>Array</option></term> <listitem><para>If you specify this option, you must specify <emphasis role="italic">arguments</emphasis>, which is an Array object. @@ -2953,10 +2956,10 @@ -- count all instance methods of .String only -say ''~instancemethods(.String)~allindexes~items --> 116 +say ''~instanceMethods(.String)~allIndexes~items --> 116 -- count all instance methods of .String and its superclasses -say ''~instancemethods~allindexes~items --> 148 +say ''~instanceMethods~allIndexes~items --> 148 </programlisting> </example> </section> @@ -3139,18 +3142,20 @@ of the receiver object, as if the receiver object had defined the method by using <methodname>setMethod</methodname>.</para> -<para>If you specify neither Individual nor Array, the method runs without -arguments.</para> -<para>If you specify the Individual or Array option, any remaining -<emphasis role="italic">argument</emphasis>s are arguments for the method. +<para>If you specify neither <option>Individual</option> nor <option>Array</option>, +the method runs without arguments. +</para> +<para>If you specify the <option>Individual</option> or <option>Array</option> option, +any remaining <emphasis role="italic">argument</emphasis>s are arguments for the method. (You need to specify only the first letter; -all characters following the first character are ignored.) </para> +all characters following the first character are ignored.) +</para> <variablelist> -<varlistentry><term>Individual</term> +<varlistentry><term><option>Individual</option></term> <listitem><para>Passes any remaining <emphasis role="italic">arguments</emphasis> to the method as arguments in the order you specify them. </para></listitem></varlistentry> -<varlistentry><term>Array</term> +<varlistentry><term><option>Array</option></term> <listitem><para>Requires <emphasis role="italic">arguments</emphasis>, which is an Array object. The member items of the array are passed to the method @@ -3162,12 +3167,15 @@ <para><emphasis role="bold">Notes:</emphasis></para> <orderedlist> -<listitem><para>The RUN method is a -private method. -See <xref linkend="pubpri" /> -for information about private method restrictions. +<listitem><para>The <methodname>run</methodname> method is a private method (see +<xref linkend="pubpri" />) with the additional restriction that it can only be called +<itemizedlist spacing="compact"> + <listitem><para>from an instance method of the receiving object itself, or</para></listitem> + <listitem><para>from a class method in the receiving object's inheritance chain.</para></listitem> +</itemizedlist> </para></listitem> -<listitem><para>The RUN method is a protected method.</para></listitem> +<listitem><para>The <methodname>run</methodname> method is a protected method. +</para></listitem> </orderedlist> </section> @@ -3315,21 +3323,23 @@ </para> <para>The third parameter is optional, and describes if the method that is attached to an -object should have object or float scope. "FLOAT" scope, which is the default, means that -it shares the same scope with methods that were defined outside of -a class. "OBJECT" scope means it shares the scope with other, -potentially statically defined, methods of the object it is -attached to.</para> +object should have <literal>OBJECT</literal> or <literal>FLOAT</literal> scope. +<literal>FLOAT</literal> scope, which is the default, means that it shares +the same scope with methods that were defined outside of a class. +<literal>OBJECT</literal> scope means it shares the scope with other, +potentially statically defined, methods of the object it is attached to. +</para> <para><emphasis role="bold">Notes:</emphasis></para> <orderedlist> +<listitem><para>The <methodname>setMethod</methodname> method is a private method (see +<xref linkend="pubpri" />) with the additional restriction that it can only be called +<itemizedlist spacing="compact"> + <listitem><para>from an instance method of the receiving object itself, or</para></listitem> + <listitem><para>from a class method in the receiving object's inheritance chain.</para></listitem> +</itemizedlist> +</para></listitem> <listitem><para>The <methodname>setMethod</methodname> -method is a private method. -See the <xref linkend="mthMethodSetPrivate" xrefstyle="select:title"/> method -for details. -</para> -</listitem> -<listitem><para>The <methodname>setMethod</methodname> method is a protected method.</para></listitem> </orderedlist> </section> @@ -3515,13 +3525,14 @@ <para><emphasis role="bold">Notes:</emphasis></para> <orderedlist> +<listitem><para>The <methodname>unsetMethod</methodname> method is a private method (see +<xref linkend="pubpri" />) with the additional restriction that it can only be called +<itemizedlist spacing="compact"> + <listitem><para>from an instance method of the receiving object itself, or</para></listitem> + <listitem><para>from a class method in the receiving object's inheritance chain.</para></listitem> +</itemizedlist> +</para></listitem> <listitem><para>The <methodname>unsetMethod</methodname> -method is a private method. -See the <xref linkend="mthMethodSetPrivate" xrefstyle="select:title"/> method -for details. -</para> -</listitem> -<listitem><para>The <methodname>unsetMethod</methodname> method is a protected method.</para></listitem> </orderedlist> </section> Modified: docs/trunk/rexxref/en-US/intro.xml =================================================================== --- docs/trunk/rexxref/en-US/intro.xml 2017-03-13 21:02:50 UTC (rev 11219) +++ docs/trunk/rexxref/en-US/intro.xml 2017-03-31 13:05:16 UTC (rev 11220) @@ -2841,7 +2841,7 @@ <listitem><para>The StringTable of classes declared on <xref linkend="clasdi" xrefstyle="template:::CLASS directives"/> within the current program package or added to the current package using -the <xref linkend="mthPackageAddClass" xrefstyle="template:addClass() method"/>).</para></listitem> +the <xref linkend="mthPackageAddClass" xrefstyle="template:addClass() method"/>.</para></listitem> <listitem><para>The StringTable of PUBLIC classes declared on ::CLASS directives of other files included with a <xref linkend="requ" xrefstyle="template:::REQUIRES directive"/> or added to the current Package instance using the <xref linkend="mthPackageAddPackage" xrefstyle="template:addPackage() method "/>. Modified: docs/trunk/rexxref/en-US/provide.xml =================================================================== --- docs/trunk/rexxref/en-US/provide.xml 2017-03-13 21:02:50 UTC (rev 11219) +++ docs/trunk/rexxref/en-US/provide.xml 2017-03-31 13:05:16 UTC (rev 11220) @@ -576,7 +576,7 @@ method, or, if you used <methodname>setMethod</methodname> to define the active method, the object's own class. The class symbol is usually the special variable -<xref linkend="xsuper" xrefstyle="template:SUPER"/>) or an +<xref linkend="xsuper" xrefstyle="template:SUPER"/>, but it can be any <xref linkend="ensym" xrefstyle="template:environment symbol"/> or variable name whose value is a valid class.</para></listitem> </orderedlist> |