[Laszlo-dev] For Review: Change 20080616-dda-g Summary: Show or don't show 'Attributes/Methods/Events' heading depending on inheritance.

[Donald Anderson]

Change 20080616-dda-g by dda at 33.sub-75-193-82.myvzw.com on 2008-06-16  
12:15:15 EDT
     in /Users/dda/laszlo/src/svn/openlaszlo/trunk-doc5
     for http://svn.openlaszlo.org/openlaszlo/trunk

Summary: Show or don't show 'Attributes/Methods/Events' heading  
depending on inheritance.

New Features:

Bugs Fixed: LPP-6023

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

Documentation:

Release Notes:

Details:
    We want to show the 'Attributes' (or 'Methods', 'Event') title if  
there
    are any attributes, inherited or not, but not show it when there  
are none.
    The difficulty is that the header appears first, before we visit
    the inherited methods.  Also the existence of inherited items that
    are shown can be complicated - inherited methods can be private,  
for example.

    This implementation requires us to 'generate' the inherited list
    for attributes (or methods/events) in advance, diverting the output
    into a local variable.  The length of the variable reveals if there
    will be any inherited attributes.  This is more maintainable than
    having a separate set of functions to determine if there will be
    be inherited items.

    One small change is of ordering: class attributes (which have
    their own heading 'Class Attributes') now appear after instance
    attributes and inherited attributes instead of between them.
    Same with methods.  Events had it coded correctly, although I don't
    think there are any static events.

    Also fixed some out-of-date comments in the postprocess ruby script.

Tests:
    Rebuilt doc and looked at some particular cases:
      LzEventable.html   (no attributes - no title shown)
      lz.list.html       (no events but events inherited)
      lz.base*           various cases

Files:
M      docs/src/reference/postprocess.rb
M      docs/src/xsl/js2doc2dbk.xsl

Changeset: http://svn.openlaszlo.org/openlaszlo/patches/20080616-dda-g.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/20080616/df11f5e1/attachment.html