Approved, with one recommended change. You can make this change and
then check in; no need for further review.
Saying "Fields/Events not properly documented because they lack a
declaration in the class:" feels a bit like we're airing our dirty
laundry. This will need to be rephrased.
For LzFontManager, the 'fonts' property is really private anyway so
there isn't much to be gained by documenting it here. I would suggest
that you put that whole bit in a @devnote, so it reads:
/** Manages the font dictionary.
*
* @devnote Fields not properly documented because they lack a
declaration in the class:
* dictionary <attribute>fonts</attribute>: A hash holding named
font objects.
* Each font object contains slots for the styles that are available
* (plain, bold, italic, and/or bolditalic).
*/
For LzState, LzView, LzCanvas, and anywhere else you used the phrase,
let's say, "In addition to the {events,fields} documented below,
these {events,fields} are also available:"
On Mar 8, 2007, at 6:06 AM, Phillip George Apley wrote:
Change 20070308-papley-C by [EMAIL PROTECTED] on 2007-03-08
09:02:59 EST
in /Users/papley/src/svn/legals
for http://svn.openlaszlo.org/openlaszlo/branches/legals
Summary: More complete changes to documentation
for LPP-3354: For @event, find the DeclareEvent statement in the
source, and create a new properly-formatted js2doc comment containing
the contents of the @event comment.
New Features:
Bugs Fixed:
Technical Reviewer: [EMAIL PROTECTED]
QA Reviewer: (pending)
Doc Reviewer: [EMAIL PROTECTED]
Documentation:
Release Notes:
Details: Supercedes and incorporates previous patch. This is still a
partial resolution of this bug, but now basically has complete
coverage of the bug except for kernel files, and adding
declarations for fields and events, which are too dangerous for
inclusion now. I put documentation for undeclared fields and
events in the general class documentation temporarily. I touched a
couple of kernel files, changing only documentation (no
declarations).
Tests:
Files:
M WEB-INF/lps/lfc/kernel/swf/LzFontManager.as
M WEB-INF/lps/lfc/core/LzNode.lzs
M WEB-INF/lps/lfc/views/LzInputText.lzs
M WEB-INF/lps/lfc/views/LzText.lzs
M WEB-INF/lps/lfc/views/LzViewLinkage.lzs
M WEB-INF/lps/lfc/views/LaszloView.lzs
M WEB-INF/lps/lfc/views/LaszloCanvas.lzs
M WEB-INF/lps/lfc/helpers/LzFont.lzs
M WEB-INF/lps/lfc/helpers/LzState.lzs
M WEB-INF/lps/lfc/data/LzLazyReplicationManager.lzs
M WEB-INF/lps/lfc/data/LzDataText.lzs
M WEB-INF/lps/lfc/data/LzDataset.lzs
M WEB-INF/lps/lfc/data/LzDatasource.lzs
M WEB-INF/lps/server/src/org/openlaszlo/server/LPS.java
Changeset: http://svn.openlaszlo.org/openlaszlo/patches/20070308-
papley-C.tar
