[Laszlo-dev] For Review: Change 20090130-dda-P Summary: Restore LzDelegate documentation

[Donald Anderson]

Change 20090130-dda-P by dda at lester-2.local on 2009-01-30 15:29:33 EST
     in /Users/dda/laszlo/src/svn/openlaszlo/trunk-doc4
     for http://svn.openlaszlo.org/openlaszlo/trunk

Summary: Restore LzDelegate documentation

New Features:

Bugs Fixed: LPP-7584 [Bring lz.Delegate docs back]

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

Documentation:

Release Notes:

Details:
     In 3.x versions there were two overlapping bits of documentation,
     one referred to as <handler> and one as LzDelegate.  In 4.0 or  
thereabouts,
     LzDelegate doc came from the javascript class doc, and the  
<handler> doc
     was copied from 3.x and pasted in via some 'canned' js2doc  
(langref.xml)
     When the great renaming took place, LzDelegate got renamed
     to lz.handler (to match its <handler> tag), but in the simple doc
     tools world, the canned <handler> doc now shadowed the lz.handler  
doc
     since they were written to the same .html file.
     As a side-effect, automatically generated indices for Classes and  
Tags
     did not index the <handler> page.

     This change removes the canned documentation in preference
     to what is in the javadoc for the LzDelegate class so there is  
only ONE source
     for <handler> in the reference doc.  If there is important  
content that was lost,
     it could be either inserted into LzDelegate javadoc, and/or be  
put into the developers guide.
     Note that there was an example that may be worth recovering.

Tests:
     Rebuilt reference doc and changed the <handler> page and links to  
it in the
     index.

Files:
M      docs/src/reference/langref.xml

Changeset: http://svn.openlaszlo.org/openlaszlo/patches/20090130-dda-P.tar



--

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

voice: 617-306-2057
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/20090130/e3877cf6/attachment-0001.html