[Laszlo-dev] For Review: Change 20080515-dda-n Summary: doc tools process class variable assignments correctly, via workaround.

[Donald Anderson]

I committed this in advance of review so it will be in doc preview.

On May 15, 2008, at 7:59 PM, Donald Anderson wrote:

> Change 20080515-dda-n by dda at lester.local on 2008-05-15 19:45:54 EDT
>    in /Users/dda/laszlo/src/svn/openlaszlo/trunk-doc
>    for http://svn.openlaszlo.org/openlaszlo/trunk
>
> Summary: doc tools process class variable assignments correctly, via  
> workaround.
>
> New Features:
>
> Bugs Fixed: LPP-5995
>
> Technical Reviewer: ptw (pending)
> QA Reviewer: (pending)
> Doc Reviewer: max (pending)
>
> Documentation:
>
> Release Notes:
>
> Details:
>    Situation is:
>    class X {
>       /**javadoc**/ static y;
>       ...
>       X.y = Z;
>    }
>    The javadoc for y is lost if the assignment happens later.
>    If the declaration and initialization happen in a single  
> statement (static y = Z)
>    the problem will not appear.  But the simple code workaround is  
> not feasible in all cases.
>
>    The basic issue is that the code that processes X.y = Z is  
> creating a new X.y node in the
>    doc tree, throwing away the old one.  This needs to be fixed, but  
> in the interest of solving
>    this in the short term, a workaround is in place:  If a X.y = Z  
> is seen, and X is a known
>    class, then any processing for this node is skipped.
>
>    A current flaw is that X.y = Z must appear (not just y = Z) in  
> order for the workaround to recognize it.
>
>
> Tests:
>   Rebuilt doc and checked the LzTimerService and LzCursorService  
> pages, which did not
>   have descriptions for class variables LzTimer and LzCursor  
> respectively.
>
> Files:
> M      WEB-INF/lps/server/src/org/openlaszlo/js2doc/ 
> PropertyReference.java
> M      WEB-INF/lps/server/src/org/openlaszlo/js2doc/JS2Doc.java
>
> Changeset: http://svn.openlaszlo.org/openlaszlo/patches/20080515-dda-n.tar
>
>
>
> --
>
> Don Anderson
> Java/C/C++, Berkeley DB, systems consultant
>
> voice: 617-547-7881
> email: dda at ddanderson.com
> www: http://www.ddanderson.com
>
>
>
>


--

Don Anderson
Java/C/C++, Berkeley DB, systems consultant

voice: 617-547-7881
email: dda at ddanderson.com
www: http://www.ddanderson.com




-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://www.openlaszlo.org/pipermail/laszlo-dev/attachments/20080515/64ff2aef/attachment-0001.html