[Laszlo-dev] mixin support in doc

Donald Anderson dda at ddanderson.com
Tue May 6 08:02:53 PDT 2008


  Support for mixins in doc is here.  There's a couple potential small  
cleanups coming
soon that raise some questions for you all.

At the top right of every reference doc page there is 'Extends  
someclass'
When there are mixins, you'll now see 'With somemixin, someothermixin'.
(the names like somemixin are linked to the appropriate page).
Would you prefer more verbose:  'With mixins somemixin, someothermixin'
Or to emphasize the keywords, perhaps lower case 'with':
'with somemixin, someothermixin'.   The last would make sense if we
lower cased 'extends' also.

if a mixin does not contribute attributes (or events, functions),  
should we show the title
'Attributes inherited from somemixin' with an empty list?
That behavior (always show the title) is the same as that used for
regular inheritence.  Should we always omit the title in this case  
(and for inheritance
with no attributes) too?

FYI, 'implements' (interfaces) is not really known by the doc tools  
AFAIK.
But the fact that a class must implement all the methods says that the  
methods
are all there and potentially documented (but the doc is not pulled  
from the interface).
Perhaps that can be fixed someday.  I just wanted to clear this up  
because
this came up in discussion.

- Don

--

Don Anderson
Java/C/C++, Berkeley DB, systems consultant

voice: 617-547-7881
email: dda at ddanderson.com
www: http://www.ddanderson.com






More information about the Laszlo-dev mailing list