History | Log In     View a printable version of the current page.  
Issue Details (XML | Word | Printable)

Key: LPP-5138
Type: Bug Bug
Status: Resolved Resolved
Resolution: Fixed
Priority: P1 P1
Assignee: Benjamin Shine
Reporter: Benjamin Shine
Votes: 0
Watchers: 0
Operations

If you were logged in you would be able to see more operations.
OpenLaszlo

RefGuide: script is not meaningfully documented

Created: 21/Nov/07 10:17 AM   Updated: 22/Nov/07 12:49 PM
Component/s: Doc Tools
Affects Version/s: RingDingTools (4.1 Ref Guide + Tools)
Fix Version/s: RingDingTools (4.1 Ref Guide + Tools)

Time Tracking:
Not Specified

Severity: Minor
Fixed in Change#: 7,357
Runtime: N/A
Fix in hand: False


 Description  « Hide
There is no meaningful documentation for <script>. There should be.

 All   Comments   Work Log   Change History      Sort Order: Ascending order - Click to sort in descending order
Benjamin Shine - 22/Nov/07 12:49 PM
r7357 | ben | 2007-11-22 12:49:07 -0800 (Thu, 22 Nov 2007) | 70 lines
Changed paths:
   M /openlaszlo/trunk/WEB-INF/lps/lfc/helpers/LzState.lzs
   M /openlaszlo/trunk/WEB-INF/lps/lfc/services/LzURL.lzs
   M /openlaszlo/trunk/WEB-INF/lps/lfc/services/platform/swf/LzBrowser.as
   M /openlaszlo/trunk/docs/src/xsl/js2doc2dbk/synopsis.xsl
   M /openlaszlo/trunk/docs/src/xsl/js2doc2dbk/utilities.xsl
   M /openlaszlo/trunk/docs/src/xsl/js2doc2dbk.xsl
   M /openlaszlo/trunk/docs/src/xsl/simple-driver.xsl

Change 20071122-ben-7 by ben@slim.local on 2007-11-22 12:21:36 PST
    in /Users/ben/src/svn/openlaszlo/trunk
    for http://svn.openlaszlo.org/openlaszlo/trunk

Summary: Make documentation appear for Debug, LzBrowser (swf and dhtml), etc

New Features: Meaningful stuff in...
http://localhost:8080/trunk/docs/reference/Debug+debug.html
http://localhost:8080/trunk/docs/reference/LzBrowser+dhtml.html
http://localhost:8080/trunk/docs/reference/LzBrowser+swf7+swf8+swf9.html
http://localhost:8080/trunk/docs/reference/LzScript.html
http://localhost:8080/trunk/docs/reference/LzState.html
http://localhost:8080/trunk/docs/reference/LzURL.html
http://localhost:8080/trunk/docs/reference/LzFormatter.html

Bugs Fixed:
 LPP-5137 RefGuide: Debug is not documented
 LPP-5133 RefGuide: ensure correct documentation of LzBrowser in dhtml and swf
 LPP-5138 RefGuide: RefGuide: script is not meaningfully documented
 LPP-4933 RefGuide: missing reference pages for <script>

Technical Reviewer: ptw (for lzs only) (no reviewer for xsl)
QA Reviewer: none
Doc Reviewer: max (for LzBrowser documentation)

Documentation:
This change turns back on the flags to make static methods, attributes,
and events appear in the reference. This enables the lion's share of
documentation for LzBrowser, LzUrl, Debug, LzState, script, and more
to show up in the reference, although it had previously been hidden.

This change also lists the known direct subclasses at the very bottom
of the reference page.

Reviewers: please just note that this is an improvement over the current
state of affairs for documenting these classes. This is basically a tools
change; the content changes required to produce entirely correct
documentation will have to wait.

Release Notes:

Details:
LzBrowser.as, LzURL.lzs - mark a few methods private.

LzState.lzs - merge two sequential comments so that js2doc can find the
    documentation in the first of those comments. Repeat for each of
    __LZapplyArgs, __LZstoreRefs, __LZstoreDelegates
    
docs/src/xsl/js2doc2dbk.xsl - turn on display of static methods,
    attributes, and events. Also turn on displaying the list of known
    subclasses at the very end of the reference page.
    
docs/src/xsl/simple-driver.xsl - more testing help for figuring out
     xpaths for static methods
     
docs/src/xsl/js2doc2dbk/utilities.xsl - Instead of printing ?jstype?
     in the reference when we can't find a type, just leave it blank
     in the reference, but issue a build warning. For missing lzxtypes,
     print ?lzxtype? instead of ???. Now we'll see how many of these
     there are, and what the best way to deal is. (There were tons
     of ?jstype?s.)
     
docs/src/xsl/js2doc2dbk/synopsis.xsl - Show method names as
     MyClass.myMethodName for static methods. (That format was
     already working for instance methods.)

Tests:
See urls in "New Features" above for list of files to test.