[Laszlo-dev] For Review: Change 20080625-dda-i Summary: reference doc: handle *, |, [] in @return and @param

[Donald Anderson]

Change 20080625-dda-i by dda at lester.local on 2008-06-25 20:49:46 EDT
     in /Users/dda/laszlo/src/svn/openlaszlo/trunk-doc5
     for http://svn.openlaszlo.org/openlaszlo/trunk

Summary: reference doc: handle *, |, [] in @return and @param

New Features:

Bugs Fixed: LPP-6523 (Specifying an array type for a @return statement  
results in no output),
             LPP-5872 (Doc tools fail for *, |, and [] in parameter  
type) Partial - all except ...args case.

Technical Reviewer: (pending)
QA Reviewer: (pending)
Doc Reviewer: liorio (pending)

Documentation:

Release Notes:

Details:
     Mainly this required changing a regular expression that matches  
the @return and @param contents.
     Though we now recognize ... in the regexp for parameter names  
(used for variable/optional args
     as in '...rest'), it is not yet being transmitted to the .html  
page, so I'll leave LPP-5872 open to track that.

     Part of the problem for LzView.getDepthList was a missing javadoc  
comment.

Tests:
     Visual inspection:
       Fixed LzView.getDepthList() - now lists return type and method  
description.
       Temporarily added * to parameter/return type to make sure that  
now appears in doc.

Files:
M      WEB-INF/lps/lfc/views/LaszloView.lzs
M      WEB-INF/lps/server/src/org/openlaszlo/js2doc/ 
ReprocessComments.java

Changeset: http://svn.openlaszlo.org/openlaszlo/patches/20080625-dda-i.tar



--

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/20080625/617414af/attachment-0001.html