[Laszlo-checkins] r11913 - in openlaszlo/trunk: WEB-INF/lps/lfc/debugger docs/src/nav lps/components/debugger

[ptw@openlaszlo.org]

Author: ptw
Date: 2008-11-27 07:44:38 -0800 (Thu, 27 Nov 2008)
New Revision: 11913

Modified:
   openlaszlo/trunk/WEB-INF/lps/lfc/debugger/LzDebug.lzs
   openlaszlo/trunk/docs/src/nav/toc.xml
   openlaszlo/trunk/lps/components/debugger/library.lzx
Log:
Change 20081127-ptw-5 by ptw at dueling-banjos.home on 2008-11-27 08:25:25 EST
    in /Users/ptw/OpenLaszlo/trunk
    for http://svn.openlaszlo.org/openlaszlo/trunk

Summary: One more try at documenting <debug> tag

Bugs Fixed:
Lpp-7272

Technical Reviewer: hminsky (pending)
QA Reviewer: mamye (pending)
Doc Reviewer: lou at louiorio.com (pending)

Details:
    Move dummy <debug> class into components/debugger/library

Tests:
    ant build doc test



Modified: openlaszlo/trunk/WEB-INF/lps/lfc/debugger/LzDebug.lzs
===================================================================
--- openlaszlo/trunk/WEB-INF/lps/lfc/debugger/LzDebug.lzs	2008-11-27 10:22:58 UTC (rev 11912)
+++ openlaszlo/trunk/WEB-INF/lps/lfc/debugger/LzDebug.lzs	2008-11-27 15:44:38 UTC (rev 11913)
@@ -86,7 +86,7 @@
  * </canvas>]]>
  * </programlisting></example>
  *
- * <p>The optional <xref linkend="LzDebugConsoleWindow+debug"/> tag controls the appearance of
+ * <p>The optional <xref linkend="lz.debug"/> tag controls the appearance of
  * the debugger console window when debugging is on.</p>
  *
  * @shortdesc The Laszlo debugger

Modified: openlaszlo/trunk/docs/src/nav/toc.xml
===================================================================
--- openlaszlo/trunk/docs/src/nav/toc.xml	2008-11-27 10:22:58 UTC (rev 11912)
+++ openlaszlo/trunk/docs/src/nav/toc.xml	2008-11-27 15:44:38 UTC (rev 11913)
@@ -287,7 +287,7 @@
     
     <category title="Development">
         <item title="Debug" href="lz.DebugService+debug.html"/>
-        <item title="&amp;lt;debug&amp;gt;" href="lz.debug+debug.html"/>
+        <item title="&amp;lt;debug&amp;gt;" href="lz.debug.html"/>
         <item title="&amp;lt;SyncTester&amp;gt;" href="lz.SyncTester.html" />
         <item title="&amp;lt;Test&amp;gt;" href="lz.Test.html" />
         <item title="&amp;lt;TestCase&amp;gt;" href="lz.TestCase.html" />

Modified: openlaszlo/trunk/lps/components/debugger/library.lzx
===================================================================
--- openlaszlo/trunk/lps/components/debugger/library.lzx	2008-11-27 10:22:58 UTC (rev 11912)
+++ openlaszlo/trunk/lps/components/debugger/library.lzx	2008-11-27 15:44:38 UTC (rev 11913)
@@ -1,9 +1,53 @@
-<!---
-      @topic LZX
-      @subtopic Debugging
-  -->
 <library>
 
+  <!---
+     @lzxname debug
+     @keywords private_constructor
+     @access public
+     @topic LZX
+     @subtopic Debugging
+     @devnote NOTE [2008-11-25 ptw] Dummy class to hold documentation for <debug> tag
+     @devnote TODO [2008-11-26 ptw] Make this the real class!
+  -->
+  <class name="debug">
+    <doc>
+      <tag name="shortdesc"><text>Controlling the Laszlo debugger console window</text></tag>
+      <tag name="lzxname"><text>debug</text></tag>
+      <text>
+       <p>The optional <code>debug</code> tag controls the appearance of
+       the debugger console when debugging is on. It does <em>not</em>
+       cause the application to be compiled with debugging mode enabled.
+       By default, the debug console will appear as a <code>view</code> in
+       the application canvas, sized to fit the lower 1/2 of the canvas.
+       The usual <code>view</code> attributes can be used to size and
+       position the debug console window.  If you need to programmatically
+       control the debug console window, use the <code>name</code>
+       attribute:</p>
+
+       <example class="program" id="debug-1" title="Controlling the Debug console window">
+<![CDATA[
+<canvas debug="true" height="150" width="100%">
+ <debug name="debugwindow" y="${canvas.height - this.height}" height="80%" />
+ <button name="button">
+   <attribute name="visible" value="${canvas['debugwindow'] != null}" />
+   <attribute name="text"
+     value="${canvas['debugwindow']?((canvas.debugwindow.visible?'hide':'show') + ' debugger'):null}" />
+   <handler name="onclick">
+     canvas.debugwindow.setAttribute('visible', (! canvas.debugwindow.visible));
+   </handler>
+ </button>
+</canvas>
+]]>
+       </example>
+
+       <p>Note the conditionalization testing whether the named window
+       exists or not.  The <code>debug</code> tag will <em>not</em> create
+       a window in the application canvas if remote or console debugging
+       is enabled.</p>
+      </text>
+    </doc>
+  </class>
+
   <!-- the debug eval loader; it's platform-specific -->
   <switch>
     <when runtime="swf8">