[Laszlo-checkins] r9027 - in openlaszlo/trunk: WEB-INF/lps/lfc/services docs/src/nav lps/components/lz lps/components/utils/layouts

max@openlaszlo.org max at openlaszlo.org
Tue May 6 18:26:38 PDT 2008


Author: max
Date: 2008-05-06 18:26:31 -0700 (Tue, 06 May 2008)
New Revision: 9027

Modified:
   openlaszlo/trunk/WEB-INF/lps/lfc/services/LzTimer.lzs
   openlaszlo/trunk/WEB-INF/lps/lfc/services/LzTrack.lzs
   openlaszlo/trunk/docs/src/nav/toc.xml
   openlaszlo/trunk/lps/components/lz/gridtext.lzx
   openlaszlo/trunk/lps/components/lz/menu.lzx
   openlaszlo/trunk/lps/components/utils/layouts/constantboundslayout.lzx
Log:
Change 20080506-maxcarlson-a by maxcarlson at Roboto on 2008-05-06 12:34:02 PDT
    in /Users/maxcarlson/openlaszlo/trunk-clean
    for http://svn.openlaszlo.org/openlaszlo/trunk

Summary: Fix doc bugs in LzTimer, LzTrack, menuitem, grid, gridtext and constantboundslayout.

New Features:

Bugs Fixed: LPP-5512 - constantboundslayout reference page problems, LPP-5496 - menuitem reference page problems, LPP-5488 - gridtext reference page problems (partial), LPP-5556 - LzTrackClass reference page problems, LPP-5536 - LzTimer reference page problems

Technical Reviewer: promanik
QA Reviewer: hminsky
Doc Reviewer: (pending)

Documentation:

Release Notes:

Details: LzTimer.lzs - Rename to LzTimerService, update LzTimer instance variable docs.

LzTrack.lzs - Rename to LzTrackService, update LzTrack instance variable docs. Hide the constructor and private properties.

toc.xml - Update link to LzTrack.

menu.lzx - Update type of command attribute, docs.  Update SetHilite docs.  Update setCommand docs.

gridtext.lzx - Hide _applystyle() method.

constantboundslayout.lzx - Set type of 'value' attribute to expression.  Hide addSubview method.

Tests: 'cd docs/src;ant clean;ant reference' shows all issues for constantboundslayout resolved.  gridtext example looks fine, _applystyle() method no longer visible - inheritance chain is broken at gridcolumn, which is why the datapath attribute shows up.  LzTrack and LzTimer docs are referenced and look good.



Modified: openlaszlo/trunk/WEB-INF/lps/lfc/services/LzTimer.lzs
===================================================================
--- openlaszlo/trunk/WEB-INF/lps/lfc/services/LzTimer.lzs	2008-05-06 22:49:29 UTC (rev 9026)
+++ openlaszlo/trunk/WEB-INF/lps/lfc/services/LzTimer.lzs	2008-05-07 01:26:31 UTC (rev 9027)
@@ -52,7 +52,7 @@
   * code complexity.
   *
   */
-class LzTimerClass {
+class LzTimerService {
 /** @access private */
 var timerList = new Object;
 
@@ -190,6 +190,9 @@
   }
 }
 
-} // End of LzTimerClass
+} // End of LzTimerService
 
-var LzTimer = new LzTimerClass ();
+/**
+  * LzTimer is a shortcut for <a href="LzTimerService.html">LzTimerService</a>.
+  */
+var LzTimer = new LzTimerService();

Modified: openlaszlo/trunk/WEB-INF/lps/lfc/services/LzTrack.lzs
===================================================================
--- openlaszlo/trunk/WEB-INF/lps/lfc/services/LzTrack.lzs	2008-05-06 22:49:29 UTC (rev 9026)
+++ openlaszlo/trunk/WEB-INF/lps/lfc/services/LzTrack.lzs	2008-05-07 01:26:31 UTC (rev 9027)
@@ -100,7 +100,7 @@
   * @shortdesc Enables tracking mouse events over a group of views.
   */
 
-class LzTrackClass extends LzMiniNode {
+class LzTrackService extends LzMiniNode {
 
 /**
   * @event onmousetrackover:  sent when the mouse is over a view that is registered to
@@ -122,13 +122,17 @@
 /** @access private */
 var __LZmouseupDel = null;
 
+/** @access private */
 var __LZlastmouseup = null;
+/** @access private */
 var __LZlasthit = null;
 
+/** @access private */
 var __LZdestroydel:LzDelegate = null;
 
 
-function LzTrackClass (){
+/** @access private */
+function LzTrackService (){
     super();
 
     this.__LZtrackDel = new LzDelegate( this, "__LZtrack" );// called on idle
@@ -359,10 +363,10 @@
     }
 }
 
-} // End of LzTrackClass
+} // End of LzTrackService
 
 
-/** The single instance of this class
-  * @access private
+/**
+  * LzTrack is a shortcut for <a href="LzTrackService.html">LzTrackService</a>.
   */
-var LzTrack = new LzTrackClass();
+var LzTrack = new LzTrackService();

Modified: openlaszlo/trunk/docs/src/nav/toc.xml
===================================================================
--- openlaszlo/trunk/docs/src/nav/toc.xml	2008-05-06 22:49:29 UTC (rev 9026)
+++ openlaszlo/trunk/docs/src/nav/toc.xml	2008-05-07 01:26:31 UTC (rev 9027)
@@ -94,7 +94,7 @@
         <item title="LzKeys" href="LzKeys.html" />
         <item title="LzModeManager" href="LzModeManager.html" />
         <item title="LzTimer" href="LzTimer.html" />
-        <item title="LzTrack" href="LzTrackClass.html" />
+        <item title="LzTrack" href="LzTrack.html" />
         <item title="LzHistory" href="LzHistory.html" />
     </category>
     

Modified: openlaszlo/trunk/lps/components/lz/gridtext.lzx
===================================================================
--- openlaszlo/trunk/lps/components/lz/gridtext.lzx	2008-05-06 22:49:29 UTC (rev 9026)
+++ openlaszlo/trunk/lps/components/lz/gridtext.lzx	2008-05-07 01:26:31 UTC (rev 9027)
@@ -31,6 +31,7 @@
             return this.rowdp;
         </method>
 
+        <!--- @keywords private -->
         <method name="_applystyle" args="s">
             super._applystyle( s );
             this.setAttribute( '_textcolor' , s.textcolor );

Modified: openlaszlo/trunk/lps/components/lz/menu.lzx
===================================================================
--- openlaszlo/trunk/lps/components/lz/menu.lzx	2008-05-06 22:49:29 UTC (rev 9026)
+++ openlaszlo/trunk/lps/components/lz/menu.lzx	2008-05-07 01:26:31 UTC (rev 9027)
@@ -225,10 +225,10 @@
         <attribute name="delaytime" value="300" />
         
         <!--- the command object assigned to be executed when this menuitem is selected -->
-        <attribute name="command"   value="null" 
+        <attribute name="command" value="null" type="command"
                    setter="this.setCommand( command )"   when="once" />
                            
-        <!--- this event is sent to the menuitem when it is seleted -->
+        <!--- this event is sent to the menuitem when it is selected -->
         <event name="onselect" />
 
         <!---  @keywords private -->
@@ -311,7 +311,7 @@
         
          <!---  Called automatically by the menu. The default action uses the colors
                 defined in a styles object to change the colors of the background and text. 
-                @params boolean ishilite: true shows hilite and false restores it back-->
+                @param boolean ishilite: true shows the hilite and false restores it back-->
          <method name="setHilite" args="ishilite" >
             super.setHilite( ishilite );
             if ( !_initcomplete ) return;
@@ -364,7 +364,8 @@
         </method>
                     
         <!--- call this method to set the command associated with a menuitem 
-             @param Command cmd: -->
+             @param LzCommand cmd: the command object to be executed when this menuitem is selected 
+             -->
        <method name="setCommand" args="cmd" >
             this.command = cmd;
             if ( this.command ) {

Modified: openlaszlo/trunk/lps/components/utils/layouts/constantboundslayout.lzx
===================================================================
--- openlaszlo/trunk/lps/components/utils/layouts/constantboundslayout.lzx	2008-05-06 22:49:29 UTC (rev 9026)
+++ openlaszlo/trunk/lps/components/utils/layouts/constantboundslayout.lzx	2008-05-07 01:26:31 UTC (rev 9027)
@@ -3,14 +3,16 @@
 
         <!--- The constant value that is applied to the attribute
               ( defined in 'axis' as 'x' or 'y' ) of each subview in the layout. --> 
-        <attribute name="value" value="0" />
+        <attribute name="value" value="0" type="expression"/>
         
         <!--- The axis in which this layout operates either 'x' or 'y'.  -->
         <attribute name="axis" value="y" type="string"/>
 
         <!--- this method is called by the layout class as each new subview is added
               to a layout. It is extended here to define which events on a subview
-              will activate the update method of this particular layout -->
+              will activate the update method of this particular layout
+              @keywords private 
+              @param LzView newsub: The subview to add.  -->
         <method name="addSubview" args="newsub">
             this.updateDelegate.register( newsub,  "onx");
             this.updateDelegate.register( newsub,  "ony");



More information about the Laszlo-checkins mailing list