[Laszlo-checkins] r11754 - in openlaszlo/trunk: docs/src/nav lps/components/rpc

[lou@openlaszlo.org]

Author: lou
Date: 2008-11-13 07:53:36 -0800 (Thu, 13 Nov 2008)
New Revision: 11754

Modified:
   openlaszlo/trunk/docs/src/nav/toc.xml
   openlaszlo/trunk/lps/components/rpc/rpc.lzx
Log:
Change 20081113-lou-C by lou at loumac.local on 2008-11-13 11:42:04 AST
    in /Users/lou/src/svn/openlaszlo/trunk
    for http://svn.openlaszlo.org/openlaszlo/trunk

Summary: lz.param: clarify return type in the reference, fix nav pane entries

Bugs Fixed: LPP-7327, LPP-7323

Technical Reviewer: (pending)
QA Reviewer: (pending)
Doc Reviewer: Tucker

Details: document that getValue() returns String
move lz.param to RCP category
add lz.Param to Data category

Tests: visual verify



Modified: openlaszlo/trunk/docs/src/nav/toc.xml
===================================================================
--- openlaszlo/trunk/docs/src/nav/toc.xml	2008-11-13 15:52:15 UTC (rev 11753)
+++ openlaszlo/trunk/docs/src/nav/toc.xml	2008-11-13 15:53:36 UTC (rev 11754)
@@ -134,7 +134,7 @@
         <item title="&amp;lt;dataset&amp;gt;" href="lz.dataset.html" />
         <item title="&amp;lt;httpdataprovider&amp;gt;" href="lz.httpdataprovider.html" />
         <item title="&amp;lt;httpdatarequest&amp;gt;" href="lz.httpdatarequest.html" />
-        <item title="lz.Param" href="lz.param.html" />
+        <item title="lz.Param" href="lz.params.html" />
         <item title="lz.DataElement" href="lz.DataElement.html" />
         <item title="lz.DataNode" href="lz.DataNode.html" />
         <item title="lz.DataNodeMixin" href="lz.DataNodeMixin.html" />
@@ -210,7 +210,7 @@
     </category>
     <category title="RPC">
         <item title="&amp;lt;javarpc&amp;gt;" href="lz.javarpc.html" />
-<!--        <item title="&amp;lt;param&amp;gt;" href="lz.param.html" /> -->
+        <item title="&amp;lt;param&amp;gt;" href="lz.param.html" />
         <item title="&amp;lt;rpc&amp;gt;" href="lz.rpc.html" />
         <item title="&amp;lt;remotecall&amp;gt;" href="lz.remotecall.html" />
         <item title="&amp;lt;soap&amp;gt;" href="lz.soap.html" />

Modified: openlaszlo/trunk/lps/components/rpc/rpc.lzx
===================================================================
--- openlaszlo/trunk/lps/components/rpc/rpc.lzx	2008-11-13 15:52:15 UTC (rev 11753)
+++ openlaszlo/trunk/lps/components/rpc/rpc.lzx	2008-11-13 15:53:36 UTC (rev 11754)
@@ -716,11 +716,13 @@
 
     <!-- 'Element to use inside remotecall. -->
     <class name="param" extends="node">
-        <!--- Value to use for paramter. A getValue() method can be declared
+        <!--- Value to use for paramter. A <code>getValue()</code> method can be declared
               inside param to use its return as the parameter value. If both
-              value attribute and getValue method are declared, param will use
-              getValue(). -->
+              <code>value</code> attribute and <code>getValue()</code> method are declared, param will use
+              <code>getValue()</code>. -->
         <attribute name="value" value="null" type="expression" />
+        <!--- Returns value.
+            @return String: the string representing the value. -->
         <method name="getValue">
           return this.value;
         </method>
@@ -728,9 +730,9 @@
             <tag name="shortdesc"><text>param tag for remotecall</text></tag>
             <text>
                 <p>Tag to declaratively set parameter values for <sgmltag class="element" role="lz.remotecall">&lt;remotecall&gt;</sgmltag>. If a 
-                    getValue method is declared in the body of remotecall, use its return as 
-                    value for paramter. If both getValue method and value attribute are set in 
-                    param, getValue wins.</p>
+                    <code>getValue()</code> method is declared in the body of <code>remotecall</code>, use its return as 
+                    value for paramter. If both <code>getValue()</code> method and <code>value</code> attribute are set in 
+                    param, <code>getValue()</code> wins.</p>
                 <programlisting title="Usage example">
     &lt;remotecall name="func1" funcname="someFunc"&gt;
         &lt;param value="'some string value'" /&gt;