[Laszlo-dev] For Review: Change 20081204-ptw-5 Summary: Improve formatToString documentation and examples

[Lou Iorio]

approved, but a few issues:

LzFormatter:

The first line on the page, "Formatted output support " should be a  
shortdesc,
not a <p>.

I find the example on positional arguments a little confusing.

It seems to me that "last after first" in the output should be "last  
before first".

How about:

<canvas layout="axis: y; spacing: 10" height="80" width="100%">
   <debug y="5%" height="90%" />
   <script>
     var date = {us: "%1$s, %2$s", eu: "%2$s, %1$s"};
   </script>
   <text oninit="this.format(date.us, 'month', 'day')" />
   <text oninit="this.format(date.eu, 'month', 'day');"/>
</canvas>

In the formatToString() method:

There is a hyperlink with the text "Unix printf(3)" that seems to want  
to open
a man page. This, on the mac at least, does not work.

In the description for the parameter args, it mentions LzMessage, but  
LzMessage
is private, and there is no doc for it.

LzDebugservice has a couple of broken xrefs:

The debugger can be used to trace method calls using ??? and it can be  
used to monitor instance variables using ???


On Dec 5, 2008, at 3:01 PM, P T Withington wrote:

> [Checking in so you can review.]
>
> Change 20081204-ptw-5 by ptw at dueling-banjos.home on 2008-12-04  
> 13:51:43 EST
>    in /Users/ptw/OpenLaszlo/trunk
>    for http://svn.openlaszlo.org/openlaszlo/trunk
>
> Summary: Improve formatToString documentation and examples
>
> Bugs Fixed:
> LPP-7437  Emphasize Debug.debug over Debug.write in documentation  
> examples (partial)
>
> Technical Reviewer: lou at louiorio.com (pending)
>
> Details:
>    LzMessage, LzDebug, LzMonitor, LzTrace, LzText: Update type
>    declarations to something the doc tool will grok
>
>    LzDebug, LzText, LzFormatter: Update links to instance variables
>    since the doc tool does not know what to do with an xref.
>
>    LzNode, LzText: Add missing private declarations
>
>    LzFormatter: Add examples suggested in bug report.  Improve the
>    documentation of formatToString.  Make formatToString not complain
>    about extra arguments when using positional arguments.
>
>    debugger/library: Remove <>'s that were making the doc tool
>    whine.  Improve the documentation to make it clearer that there
>    will not always be a debugger console window that you can
>    manipulate.
>
> Tests:
>    smokecheck, examples from bug, ant doc and inspection
>
> Files:
> M      WEB-INF/lps/lfc/debugger/LzMessage.lzs
> M      WEB-INF/lps/lfc/debugger/LzDebug.lzs
> M      WEB-INF/lps/lfc/debugger/LzMonitor.lzs
> M      WEB-INF/lps/lfc/debugger/LzTrace.lzs
> M      WEB-INF/lps/lfc/core/LzNode.lzs
> M      WEB-INF/lps/lfc/views/LzText.lzs
> M      WEB-INF/lps/lfc/compiler/LzFormatter.lzs
> M      lps/components/debugger/library.lzx
>
> Changeset: http://svn.openlaszlo.org/openlaszlo/patches/20081204-ptw-5.tar