[Laszlo-checkins] r10194 - in openlaszlo/trunk: WEB-INF/lps/lfc/services docs/src/nav
pbr@openlaszlo.org
pbr at openlaszlo.org
Thu Jul 3 13:38:30 PDT 2008
Author: pbr
Date: 2008-07-03 13:38:21 -0700 (Thu, 03 Jul 2008)
New Revision: 10194
Modified:
openlaszlo/trunk/WEB-INF/lps/lfc/services/LzAudio.lzs
openlaszlo/trunk/WEB-INF/lps/lfc/services/LzBrowser.lzs
openlaszlo/trunk/WEB-INF/lps/lfc/services/LzCursor.lzs
openlaszlo/trunk/WEB-INF/lps/lfc/services/LzFocus.lzs
openlaszlo/trunk/WEB-INF/lps/lfc/services/LzGlobalMouse.lzs
openlaszlo/trunk/WEB-INF/lps/lfc/services/LzHistory.lzs
openlaszlo/trunk/WEB-INF/lps/lfc/services/LzIdle.lzs
openlaszlo/trunk/WEB-INF/lps/lfc/services/LzInstantiator.lzs
openlaszlo/trunk/WEB-INF/lps/lfc/services/LzKeys.lzs
openlaszlo/trunk/WEB-INF/lps/lfc/services/LzModeManager.lzs
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
Log:
Change 20080703-Philip-0 by Philip at Philip-DC on 2008-07-03 16:23:35 EDT
in /cygdrive/f/laszlo/svn/src/svn/openlaszlo/trunk
for http://svn.openlaszlo.org/openlaszlo/trunk
Summary: Fix doc comments for service objects
New Features:
Bugs Fixed: LPP-6570
Technical Reviewer: (pending)
QA Reviewer: (pending)
Doc Reviewer: (pending)
Documentation:
Release Notes:
Details:
Some of the documentation comments in the service files still referenced the deprecated (now removed) globals such as LzGlobalMouse and LzCursor. These have been fixed.
I added one sentence to the docs for each service that briefly describes the relationship of a class (ex: LzGlobalMouseService) to the single instance of the class (ex: lz.GlobalMouse).
I modified toc.xml to reference the service pages. It was referencing the deprecated objects that are now deleted.
Tests:
By inspection. I will verify the changes after the nightly builds run. I think at least one of the sample apps is broken but I won't know for sure until the docs are built.
Files:
M WEB-INF/lps/lfc/services/LzTrack.lzs
M WEB-INF/lps/lfc/services/LzGlobalMouse.lzs
M WEB-INF/lps/lfc/services/LzKeys.lzs
M WEB-INF/lps/lfc/services/LzIdle.lzs
M WEB-INF/lps/lfc/services/LzCursor.lzs
M WEB-INF/lps/lfc/services/LzModeManager.lzs
M WEB-INF/lps/lfc/services/LzInstantiator.lzs
M WEB-INF/lps/lfc/services/LzFocus.lzs
M WEB-INF/lps/lfc/services/LzTimer.lzs
M WEB-INF/lps/lfc/services/LzBrowser.lzs
M WEB-INF/lps/lfc/services/LzHistory.lzs
M WEB-INF/lps/lfc/services/LzAudio.lzs
M docs/src/nav/toc.xml
Changeset: http://svn.openlaszlo.org/openlaszlo/patches/20080703-Philip-0.tar
Modified: openlaszlo/trunk/WEB-INF/lps/lfc/services/LzAudio.lzs
===================================================================
--- openlaszlo/trunk/WEB-INF/lps/lfc/services/LzAudio.lzs 2008-07-03 20:32:32 UTC (rev 10193)
+++ openlaszlo/trunk/WEB-INF/lps/lfc/services/LzAudio.lzs 2008-07-03 20:38:21 UTC (rev 10194)
@@ -9,11 +9,14 @@
*/
/**
+ * <p><code>lz.Audio</code> is the single instance of the class
+ * <code>LzAudioService</code>.</p>
+ *
* <example><![CDATA[
<canvas height="150">
<audio src="resources/poof.mp3" name="poof"/>
<button text="Poof"
- onclick="LzAudio.playSound('poof');"/>
+ onclick="lz.Audio.playSound('poof');"/>
</canvas>]]></example>
*
*
Modified: openlaszlo/trunk/WEB-INF/lps/lfc/services/LzBrowser.lzs
===================================================================
--- openlaszlo/trunk/WEB-INF/lps/lfc/services/LzBrowser.lzs 2008-07-03 20:32:32 UTC (rev 10193)
+++ openlaszlo/trunk/WEB-INF/lps/lfc/services/LzBrowser.lzs 2008-07-03 20:38:21 UTC (rev 10194)
@@ -9,18 +9,21 @@
*/
/**
+ * <p><code>lz.Browser</code> is the single instance of the class
+ * <code>LzBrowserService</code>.</p>
+ *
* <p>Interface to the browser via the runtime kernel</p>
- * <p>The <classname>LzBrowser</classname> service provides access to the browser and player environment.
+ * <p>The <classname>lz.Browser</classname> service provides access to the browser and player environment.
* It includes methods to load URLs in the browser, and check the version of the player. For example:</p>
- * <example title="Using LzBrowser to launch another browser">
+ * <example title="Using lz.Browser to launch another browser">
* <![CDATA[<canvas height="140" debug="true">
* <!-- Load the Laszlo site in a new window -->
- * <button onclick="LzBrowser.loadURL('http://www.laszlosystems.com/', '_blank')">
+ * <button onclick="lz.Browser.loadURL('http://www.laszlosystems.com/', '_blank')">
* Click me
* </button>
* <script>
* // List the player version
- * Debug.write('Player version: ' + LzBrowser.getVersion());
+ * Debug.write('Player version: ' + lz.Browser.getVersion());
* </script>
* </canvas>]]>
* </example>
@@ -29,7 +32,7 @@
*/
class LzBrowserService {
/** The browser service. Also available as the global
- * <code>LzBrowser</code>.
+ * <code>lz.Browser</code>.
*
* @type LzBrowserService
* @keywords readonly
@@ -215,7 +218,7 @@
//Debug.write('load url', u.toString());
//for LzURL: protocol,host, port, path, file, query
- /* Description: LzBrowser.toAbsoluteURL('http:/zot/foo.bar') =>
+ /* Description: lz.Browser.toAbsoluteURL('http:/zot/foo.bar') =>
http://127.0.0.1:8080/lps-dev-bug/examples//zot/foo.bar
I would have hoped for:
http://127.0.0.1:8080/zot/foo.bar
Modified: openlaszlo/trunk/WEB-INF/lps/lfc/services/LzCursor.lzs
===================================================================
--- openlaszlo/trunk/WEB-INF/lps/lfc/services/LzCursor.lzs 2008-07-03 20:32:32 UTC (rev 10193)
+++ openlaszlo/trunk/WEB-INF/lps/lfc/services/LzCursor.lzs 2008-07-03 20:38:21 UTC (rev 10194)
@@ -10,10 +10,13 @@
*/
/**
-* <p>This example shows how the cursor can be set on a view so that
+ * <p><code>lz.Cursor</code> is the single instance of the class
+ * <code>LzCursorService</code>.</p>
+ *
+ * <p>This example shows how the cursor can be set on a view so that
* it will change when the mouse is over that view:</p>
-*
-* <example title="Setting the cursor for a view">
+ *
+ * <example title="Setting the cursor for a view">
* <canvas height="30">
* <resource name="waitcursor" src="resources/lzwaitcursor_rsc.swf"/>
* <view bgcolor="yellow" cursor="waitcursor">
@@ -25,13 +28,13 @@
* <p>This example changes the cursor for 1/2 second when the button is
* clicked:</p>
*
-* <example title="Changing the cursor with LzCursor">
+* <example title="Changing the cursor with lz.Cursor">
* <canvas height="30">
* <resource name="waitcursor" src="resources/lzwaitcursor_rsc.swf"/>
* <button onclick="setCursor()" text="Click me to change the cursor for 1/2 second">
* <method name="setCursor">
* lz.Cursor.setCursorGlobal('waitcursor');
- * var del= new LzDelegate(LzCursor, 'unlock');
+ * var del= new LzDelegate(lz.Cursor, 'unlock');
* lz.Timer.addTimer(del, 500);
* </method>
* </button>
Modified: openlaszlo/trunk/WEB-INF/lps/lfc/services/LzFocus.lzs
===================================================================
--- openlaszlo/trunk/WEB-INF/lps/lfc/services/LzFocus.lzs 2008-07-03 20:32:32 UTC (rev 10193)
+++ openlaszlo/trunk/WEB-INF/lps/lfc/services/LzFocus.lzs 2008-07-03 20:38:21 UTC (rev 10194)
@@ -10,6 +10,9 @@
*/
/**
+ * <p><code>lz.Focus</code> is the single instance of the class
+ * <code>LzFocusService</code>.</p>
+ *
* <p>This service manages the keyboard focus. At any time, at most one view
* has the keyboard focus. This is the view that receives key events
* when a key is pressed.</p>
Modified: openlaszlo/trunk/WEB-INF/lps/lfc/services/LzGlobalMouse.lzs
===================================================================
--- openlaszlo/trunk/WEB-INF/lps/lfc/services/LzGlobalMouse.lzs 2008-07-03 20:32:32 UTC (rev 10193)
+++ openlaszlo/trunk/WEB-INF/lps/lfc/services/LzGlobalMouse.lzs 2008-07-03 20:38:21 UTC (rev 10194)
@@ -10,9 +10,12 @@
*/
/**
- * <p>The <code>LzGlobalMouse</code> service sends events any time the
+ * <p><code>lz.GlobalMouse</code> is the single instance of the class
+ * <code>LzGlobalMouseService</code>.</p>
+ *
+ * <p>The <code>lz.GlobalMouse</code> service sends events any time the
* mouse button state changes, even if mouse events are locked using
- * the <classname>lz.ModeManager</classname> API. The LzGlobalMouse is
+ * the <classname>lz.ModeManager</classname> API. The lz.GlobalMouse is
* also useful for detecting when the mouse button goes up or down on
* a non-clickable view.</p>
*
@@ -27,9 +30,9 @@
* }
* </handler>
*
- * <handler name="onclick" reference="LzGlobalMouse" args="who">
- * //need to use LzGlobalMouse, since we don't get clicks if we're
- * //checked. Note: LzGlobalMouse sends its events before the view
+ * <handler name="onclick" reference="lz.GlobalMouse" args="who">
+ * //need to use lz.GlobalMouse, since we don't get clicks if we're
+ * //checked. Note: lz.GlobalMouse sends its events before the view
* //receives the events, so we can just unlock it here, and the
* //checkbox can do its normal onclick handling.
* if (this.value && who == this){
@@ -45,28 +48,28 @@
* this.format("%s: %w", what, who);
* </method>
*
- * <handler name="onmouseover" reference="<em>LzGlobalMouse</em>" args="who">
+ * <handler name="onmouseover" reference="lz.GlobalMouse" args="who">
* this.showEvent("mouseover" , who);
* </handler>
- * <handler name="onmouseout" reference="<em>LzGlobalMouse</em>" args="who">
+ * <handler name="onmouseout" reference="lz.GlobalMouse" args="who">
* this.showEvent("mouseout" , who);
* </handler>
*
- * <handler name="onmousedown" reference="<em>LzGlobalMouse</em>" args="who">
+ * <handler name="onmousedown" reference="lz.GlobalMouse" args="who">
* this.showEvent("mousedown" , who);
* </handler>
- * <handler name="onmouseup" reference="<em>LzGlobalMouse</em>" args="who">
+ * <handler name="onmouseup" reference="lz.GlobalMouse" args="who">
* this.showEvent("mouseup" , who);
* </handler>
*
- * <handler name="onclick" reference="<em>LzGlobalMouse</em>" args="who">
+ * <handler name="onclick" reference="lz.GlobalMouse" args="who">
* this.showEvent("mouseclick" , who);
* </handler>
* </text>
* </canvas>
* ]]></programlisting></example>
*
- * <p>Use the LzGlobalMouse service in conjunction with <classname>lz.ModeManager</classname>'s event lock.</p>
+ * <p>Use the lz.GlobalMouse service in conjunction with <classname>lz.ModeManager</classname>'s event lock.</p>
*
* @shortdesc Application-wide control of and information about the mouse.
* @see mode example
@@ -78,7 +81,7 @@
public class LzGlobalMouseService extends LzEventable {
/**
* The global mouse service. Also available as the global
- * <code>LzGlobalMouse</code>.
+ * <code>lz.GlobalMouse</code>.
*
* @type LzGlobalMouseService
* @keywords readonly
Modified: openlaszlo/trunk/WEB-INF/lps/lfc/services/LzHistory.lzs
===================================================================
--- openlaszlo/trunk/WEB-INF/lps/lfc/services/LzHistory.lzs 2008-07-03 20:32:32 UTC (rev 10193)
+++ openlaszlo/trunk/WEB-INF/lps/lfc/services/LzHistory.lzs 2008-07-03 20:38:21 UTC (rev 10194)
@@ -10,6 +10,9 @@
*/
/**
+ * <p><code>lz.History</code> is the single instance of the class
+ * <code>LzHistoryService</code>.</p>
+ *
* <p>The lz.History service manages interaction with the browser history and back button. Save state as often as you like, and advance the
* history when a new 'page' of values is required.</p>
*
Modified: openlaszlo/trunk/WEB-INF/lps/lfc/services/LzIdle.lzs
===================================================================
--- openlaszlo/trunk/WEB-INF/lps/lfc/services/LzIdle.lzs 2008-07-03 20:32:32 UTC (rev 10193)
+++ openlaszlo/trunk/WEB-INF/lps/lfc/services/LzIdle.lzs 2008-07-03 20:38:21 UTC (rev 10194)
@@ -10,6 +10,9 @@
*/
/**
+ * <p><code>lz.Idle</code> is the single instance of the class
+ * <code>LzIdleService</code>.</p>
+ *
* <p>The OpenLaszlo runtime generates idle events at a fixed,
* unspecified frequency. Here is a simple example that shows how to
* receive the <event>onidle</event> event:</p>
Modified: openlaszlo/trunk/WEB-INF/lps/lfc/services/LzInstantiator.lzs
===================================================================
--- openlaszlo/trunk/WEB-INF/lps/lfc/services/LzInstantiator.lzs 2008-07-03 20:32:32 UTC (rev 10193)
+++ openlaszlo/trunk/WEB-INF/lps/lfc/services/LzInstantiator.lzs 2008-07-03 20:38:21 UTC (rev 10194)
@@ -9,6 +9,9 @@
*/
/**
+ * <p><code>lz.Instantiator</code> is the single instance of the class
+ * <code>LzInstantiatorService</code>.</p>
+ *
* <p>The instantiator is responsible for timing the creation and
* initialization of Laszlo applications. Because of Laszlo's
* declarative style, applications must be instantiated in two passes
@@ -35,7 +38,7 @@
/**
* The instantiator service. Also available as the global
- * <code>LzInstantiator</code>.
+ * <code>lz.Instantiator</code>.
*
* @type LzInstantiatorService
* @keywords readonly
Modified: openlaszlo/trunk/WEB-INF/lps/lfc/services/LzKeys.lzs
===================================================================
--- openlaszlo/trunk/WEB-INF/lps/lfc/services/LzKeys.lzs 2008-07-03 20:32:32 UTC (rev 10193)
+++ openlaszlo/trunk/WEB-INF/lps/lfc/services/LzKeys.lzs 2008-07-03 20:38:21 UTC (rev 10194)
@@ -10,6 +10,9 @@
*/
/**
+ * <p><code>lz.Keys</code> is the single instance of the class
+ * <code>LzKeysService</code>.</p>
+ *
* lz.Keys is a service that provides key handling messages. Objects can also
* register callbacks to be sent when specific key combinitions are down.
*
Modified: openlaszlo/trunk/WEB-INF/lps/lfc/services/LzModeManager.lzs
===================================================================
--- openlaszlo/trunk/WEB-INF/lps/lfc/services/LzModeManager.lzs 2008-07-03 20:32:32 UTC (rev 10193)
+++ openlaszlo/trunk/WEB-INF/lps/lfc/services/LzModeManager.lzs 2008-07-03 20:38:21 UTC (rev 10194)
@@ -10,6 +10,9 @@
*/
/**
+ * <p><code>lz.ModeManager</code> is the single instance of the class
+ * <code>LzModeManagerService</code>.</p>
+ *
* <p>
* The mode manager controls the dispatch of mouse events to the rest
* of the system. The mode manager keeps a stack of modal views. When a
Modified: openlaszlo/trunk/WEB-INF/lps/lfc/services/LzTimer.lzs
===================================================================
--- openlaszlo/trunk/WEB-INF/lps/lfc/services/LzTimer.lzs 2008-07-03 20:32:32 UTC (rev 10193)
+++ openlaszlo/trunk/WEB-INF/lps/lfc/services/LzTimer.lzs 2008-07-03 20:38:21 UTC (rev 10194)
@@ -9,6 +9,9 @@
*/
/**
+ * <p><code>lz.Timer</code> is the single instance of the class
+ * <code>LzTimerService</code>.</p>
+ *
* <p>lz.Timer is used to invoke functionality after a specific
* amount of time. By using a <xref linkend="LzDelegate"/> to refer
* to a particular method, and then by adding a timer to that
Modified: openlaszlo/trunk/WEB-INF/lps/lfc/services/LzTrack.lzs
===================================================================
--- openlaszlo/trunk/WEB-INF/lps/lfc/services/LzTrack.lzs 2008-07-03 20:32:32 UTC (rev 10193)
+++ openlaszlo/trunk/WEB-INF/lps/lfc/services/LzTrack.lzs 2008-07-03 20:38:21 UTC (rev 10194)
@@ -10,6 +10,9 @@
*/
/**
+ * <p><code>lz.Track</code> is the single instance of the class
+ * <code>LzTrackService</code>.</p>
+ *
* <p>This service helps tracking the mouse over a number of views, as in
* common when implementing menus and drag-and-drop behaviors. When the
* mouse is down, standard view events such as <event>onmousedragin</event>
Modified: openlaszlo/trunk/docs/src/nav/toc.xml
===================================================================
--- openlaszlo/trunk/docs/src/nav/toc.xml 2008-07-03 20:32:32 UTC (rev 10193)
+++ openlaszlo/trunk/docs/src/nav/toc.xml 2008-07-03 20:38:21 UTC (rev 10194)
@@ -91,13 +91,13 @@
<item title="handler (LzDelegate)" href="LzDelegate.html" />
<item title="event (LzEvent)" href="LzEvent.html" />
<item title="LzEventable" href="LzEventable.html" />
- <item title="LzGlobalMouse" href="LzGlobalMouse.html" />
- <item title="LzIdle" href="LzIdle.html" />
- <item title="LzKeys" href="LzKeys.html" />
- <item title="LzModeManager" href="LzModeManager.html" />
- <item title="LzTimer" href="LzTimer.html" />
- <item title="LzTrack" href="LzTrack.html" />
- <item title="LzHistory" href="LzHistory.html" />
+ <item title="LzGlobalMouse" href="LzGlobalMouseService.html" />
+ <item title="LzIdle" href="LzIdleService.html" />
+ <item title="LzKeys" href="LzKeysService.html" />
+ <item title="LzModeManager" href="LzModeManagerService.html" />
+ <item title="LzTimer" href="LzTimerService.html" />
+ <item title="LzTrack" href="LzTrackService.html" />
+ <item title="LzHistory" href="LzHistoryService.html" />
</category>
@@ -116,12 +116,11 @@
<category title="Media" >
<item title="audio" href="tag-audio.html"/>
- <item title="LzAudio" href="LzAudio.html" />
+ <item title="LzAudio" href="LzAudioService.html" />
<item title="font" href="LzFont.html" />
<item title="face" href="tag-face.html"/>
<item title="frame" href="tag-frame.html"/>
<item title="image" href="lz.image.html"/>
- <!-- TODO: [2008-01-28 dda] <item title="LzAudio" href="lz.LzAudio.html" /> -->
<item title="resource" href="tag-resource.html"/>
<!-- LzFontManager ??? -->
</category>
@@ -222,10 +221,10 @@
</category>
<category title="Services">
- <item title="LzBrowser" href="LzBrowser.html" />
- <item title="LzCursor" href="LzCursor.html" />
- <item title="LzFocus" href="LzFocus.html" />
- <item title="LzTrack" href="LzTrack.html" />
+ <item title="LzBrowser" href="LzBrowserService.html" />
+ <item title="LzCursor" href="LzCursorService.html" />
+ <item title="LzFocus" href="LzFocusService.html" />
+ <item title="LzTrack" href="LzTrackService.html" />
<item title="LzURL" href="LzURL.html" />
</category>
More information about the Laszlo-checkins
mailing list