[Laszlo-dev] For Review: Change 20080506-dda-P Summary: Handle mixins in doc

[P T Withington]

Yay!

On 2008-05-06, at 08:47 EDT, Donald Anderson wrote:

> Change 20080506-dda-P by dda at lester.local on 2008-05-06 08:28:37 EDT
>    in /Users/dda/laszlo/src/svn/openlaszlo/trunk-doc2
>    for http://svn.openlaszlo.org/openlaszlo/trunk
>
> Summary: Handle mixins in doc
>
> New Features:
>
> Bugs Fixed: LPP-5924
>
> Technical Reviewer: (pending)
> QA Reviewer: (pending)
> Doc Reviewer: liorio (pending)
>
> Documentation:
>
> Release Notes:
>
> Details:
>    When a class is defined using a mixin (class foo extends bar with  
> somemixin,someothermixin)
>    it now shows:
>    - in the top summary, the list of mixins in just below the  
> inheritence chain
>    - for each mixin, show the list of attributes inherited for that  
> method in
>      in 'Attributes inherited from ....'   Same for methods and  
> events.
>
>    Open questions:
>    - wording on the summary - we are using the concise keyword 'With  
> somemixin,someothermixin' maybe we
>      we want 'With mixin somemixin,someothermixin'?
>    - if a mixin does not contribute attributes (or events,  
> functions), should we show the title
>      'Attributes inherited from somemixin' at all if there is no  
> list below it?
>      The current behavior (always show the title) is the same as the  
> behavior as that shown
>      for regular inheritence, but is probably easy to fix.
>
> Tests:
>    at top: 'ant clean build'
>    in docs/src:  'ant clean reference'
>    Examined classes that have mixins: LzDataElement LzDataText,  
> LzDataset, LzText.
>
> Files:
> M      WEB-INF/lps/server/src/org/openlaszlo/js2doc/ 
> PropertyReference.java
> M      docs/src/xsl/js2doc2dbk.xsl
>
> Changeset: http://svn.openlaszlo.org/openlaszlo/patches/20080506-dda-P.tar
>
>
>
> --
>
> Don Anderson
> Java/C/C++, Berkeley DB, systems consultant
>
> voice: 617-547-7881
> email: dda at ddanderson.com
> www: http://www.ddanderson.com
>
>
>
>