[Laszlo-dev] For Review: Change 20080626-dda-b Summary: Fixed ... type notation for documentation

[Donald Anderson]

[committing now so it can reviewed in next build]

Change 20080626-dda-b by dda at lester.local on 2008-06-26 10:36:09 EDT
     in /Users/dda/laszlo/src/svn/openlaszlo/trunk-doc5
     for http://svn.openlaszlo.org/openlaszlo/trunk

Summary: Fixed ... type notation for documentation

New Features:

Bugs Fixed: LPP-5872 (Doc tools fail for *, |, and [] in parameter type)

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

Documentation:

Release Notes:

Details:
   Parse optional ... into a separate regexp group, and pass it through
   as part of the type, rather than the name.  This allows the name to
   match the parameter names actually seen in the JS source, and besides
   it seems logical.  ... is shown as part of the type in the attribute
   table, but the synopsis is made to match the Javascript.

   As an example, using this javadoc:
    /**
     * javadoc for someFunction
     * @param LzView foo: some text
     * @param ...rest: some other text
     */
    function someFunction (foo, ...rest)

   you'll get output:

     someClass.someFunction(foo : LzView, ...rest);
     javadoc for someFunction

     Parameter Name    Type        Description
     foo               LzView      some text
     rest              ...         some other text


Tests:
     Added example function above and verified.
     Also rebuilt docs for scratch and do quick check for regressions.
     Also verified that '|' works in types, see LzView.setVisible()

Files:
M      WEB-INF/lps/server/src/org/openlaszlo/js2doc/ 
ReprocessComments.java
M      docs/src/xsl/js2doc2dbk/synopsis.xsl

Changeset: http://svn.openlaszlo.org/openlaszlo/patches/20080626-dda-b.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/20080626/ece919ba/attachment.html