[Laszlo-checkins] r10008 - openlaszlo/trunk/WEB-INF/lps/server/src/org/openlaszlo/js2doc

[dda@openlaszlo.org]

Author: dda
Date: 2008-06-25 18:18:06 -0700 (Wed, 25 Jun 2008)
New Revision: 10008

Modified:
   openlaszlo/trunk/WEB-INF/lps/server/src/org/openlaszlo/js2doc/ReprocessComments.java
Log:
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.



Modified: openlaszlo/trunk/WEB-INF/lps/server/src/org/openlaszlo/js2doc/ReprocessComments.java
===================================================================
--- openlaszlo/trunk/WEB-INF/lps/server/src/org/openlaszlo/js2doc/ReprocessComments.java	2008-06-26 01:17:03 UTC (rev 10007)
+++ openlaszlo/trunk/WEB-INF/lps/server/src/org/openlaszlo/js2doc/ReprocessComments.java	2008-06-26 01:18:06 UTC (rev 10008)
@@ -3,7 +3,7 @@
  * ****************************************************************************/
 
 /* J_LZ_COPYRIGHT_BEGIN *******************************************************
-* Copyright 2007 Laszlo Systems, Inc.  All Rights Reserved.                   *
+* Copyright 2007, 2008 Laszlo Systems, Inc.  All Rights Reserved.             *
 * Use is subject to license terms.                                            *
 * J_LZ_COPYRIGHT_END *********************************************************/
 
@@ -185,8 +185,8 @@
     
         // TODO [jgrandy 12/14/2006] use Java5's Scanner instead of regexp here
         
-        static private final Pattern paramPattern  = Pattern.compile("^\\s*(?:(\\w+)\\s+)?(\\w*)(?::(.*))?$", Pattern.DOTALL);
-        static private final Pattern returnPattern = Pattern.compile("^\\s*(\\w+)(?::(.*))?$", Pattern.DOTALL);
+        static private final Pattern paramPattern  = Pattern.compile("^\\s*(?:([\\w\\[\\]\\|\\*]+)\\s+)?([.\\w]*)(?::(.*))?$", Pattern.DOTALL);
+        static private final Pattern returnPattern = Pattern.compile("^\\s*([\\w\\[\\]\\|\\*]+)(?::(.*))?$", Pattern.DOTALL);
     
         public ParamFieldFilter(CommentFieldFilter nextFilter) {
             super(nextFilter);