On Jan 4, 2007, at 3:14 AM, P T Withington wrote:
I went through this fairly carefully, hoping to prevent the lossage
from the last pass where somehow comment conversion absorbed code
into a comment.
Comments:
1) My primary complaint is that some important (at least to me)
comments were dropped. As with last time, the thing that seems to
have thrown your conversion off is the use of two adjacent comments
with different comment style. In particular, the following comment
seem to have been lost:
LzProfiler:
// NOTE: [2006-06-24 ptw] This code is inlined by the compiler
method
// `meterFunctionEvent` and must be kept in sync with that.
This was rewritten as a @devnote in the same file:
* @devnote [2006-06-24 ptw] This code is inlined by the compiler
method
* `meterFunctionEvent` and must be kept in sync with that.
LzDebug:
// TODO: [2006-04-20 ptw] Remove when compiler no longer references
So was this:
* @todo [2006-04-20 ptw] Remove when compiler no longer references
debugger/platform/swf/kernel.as:
// Implementation of Debug.log does not depend on any of
// the LFC working and hence can be used from startup on.
And so was this, although I didn't make the same change in the dhtml
version (it uses the original format):
* @devnote Implementation of Debug.log does not depend on any of
* the LFC working and hence can be used from startup on.
2) I'm concerned that there may be other places where adjacent
comments caused a comment to be lost that I did not find with my
eyeballs. Can you think of a way we could verify that automatically?
Since none of your examples were actually lost comments, I'm not sure
whether this is an issue.
3) In some places, FIXME/TODO's have been reformatted as @fixme
@todo and seem to have lost some annotation. Is that intentional,
if so, why? E.g.:
Semi-intentional. I think the eventual goal is to use the @todo
format in a consistent way that is easy to parse. This would actually
argue for the following format, to be consistent with @param:
+ * @todo 2004-3-29 hqm: lines seem to get the ends clipped off if
you use the TextField.textWidth
But I hadn't gotten that far :-) Basically, if a TODO was within a
larger comment block that was getting reformatted anyway, I redid it
minimally so it would parse as a structured comment field. There
would be some advantage to using @todo everywhere, since then it
would be extractable using js2doc. We'll need to make a separate pass
through at some point if we want to normalize everything and make
that happen.
-// [todo: 2004-3-29 hqm] lines seem to get the ends clipped off if
you use the TextField.textWidth
+ * @todo 2004-3-29 hqm lines seem to get the ends clipped off if
you use the TextField.textWidth
(Not that Henry had the approved format, either), and:
+ * @fixme [2006-07-26] (LPP-2412) The Instance reference is
required for lzpix
+ * to run.
-// FIXME: [2006-07-26] (LPP-2412) The Instance reference is
required for lzpix
-//
Otherwise, approved.
Thanks!
On 2007-01-03, at 01:35 EST, Jim Grandy wrote:
Change 20070102-jgrandyw-x by [EMAIL PROTECTED] on
2007-01-02 22:20:09 PST
in /Users/jgrandyw/dev/svn/openlaszlo/branches/legals
Summary: Bring new refguide over to branches/legals from private
working branch
New Features:
Bugs Fixed:LPP-3342 LPP-3255 LPP-3252 LPP-3250 LPP-3254 LPP-3251
Technical Reviewer: ptw
QA Reviewer: pga
Doc Reviewer: jsundman
Documentation:
Release Notes:
Details: Many improvements to the new refguide. Much of the LFC
wrapper
page content has been moved into the LFC sources. Class refentries
are
pretty readable now. Public/private filtering works -- although it
ended
up being part of the dbk compile step for technical reasons. Files
reference just lists entries rather than redundantly giving whole
synopses. Special forms (event, method, handler, etc.) now
documented. Components
now documented. Many (although not all) component wrappers have
migrated into
corresponding source files.
Added new book: the Contributor's Guide. Right now it contains
full details of
LZX and LFC (including private declarations), but the plan is to
eventually
include a cleaned-up docbook version of the Kernel API as well as
the javadocs
for the LPS.
Contributor's Guide and Reference Guide are both built with a
General Index,
and are available from the docs index: docs/index.html.
Note that cross-links between refguide and the other books is
still quite
broken. That's high on my priority list to fix.
Deleted some now-obsolete Python scripts.
Tests:
Files:
M WEB-INF/lps/schema/lzx.rnc
M WEB-INF/lps/lfc/kernel/svg/LzSprite.js
M WEB-INF/lps/lfc/kernel/svg/LzInputTextSprite.js
M WEB-INF/lps/lfc/kernel/svg/LzTextSprite.js
M WEB-INF/lps/lfc/kernel/swf/LzSoundMC.as
M WEB-INF/lps/lfc/kernel/swf/LzLibrary.lzs
M WEB-INF/lps/lfc/kernel/swf/LzTextSprite.as
M WEB-INF/lps/lfc/kernel/swf/LzLoader.lzs
M WEB-INF/lps/lfc/kernel/swf/LzMediaLoader.lzs
M WEB-INF/lps/lfc/kernel/swf/LzLoadQueue.as
M WEB-INF/lps/lfc/kernel/swf/LzInputTextSprite.as
M WEB-INF/lps/lfc/kernel/swf/LzFontManager.as
M WEB-INF/lps/lfc/kernel/swf/LzMakeLoadSprite.as
M WEB-INF/lps/lfc/kernel/swf/LzHTTPLoader.as
M WEB-INF/lps/lfc/kernel/swf/LzSprite.as
M WEB-INF/lps/lfc/kernel/dhtml/LzSprite.js
M WEB-INF/lps/lfc/profiler/LzProfile.lzs
M WEB-INF/lps/lfc/services/LzKeys.as
M WEB-INF/lps/lfc/services/platform/swf/LzModeManager.as
M WEB-INF/lps/lfc/services/platform/dhtml/LzModeManager.js
M WEB-INF/lps/lfc/services/platform/dhtml/LzCursor.js
M WEB-INF/lps/lfc/services/LzTrack.js
M WEB-INF/lps/lfc/services/LzCursor.as
M WEB-INF/lps/lfc/services/LzGlobalMouse.lzs
M WEB-INF/lps/lfc/services/LzIdle.lzs
M WEB-INF/lps/lfc/services/LzBrowser.as
M WEB-INF/lps/lfc/services/LzFocus.lzs
M WEB-INF/lps/lfc/services/LzInstantiator.lzs
M WEB-INF/lps/lfc/services/LzKeys.js
M WEB-INF/lps/lfc/services/LzModeManager.lzs
M WEB-INF/lps/lfc/services/LzTimer.lzs
M WEB-INF/lps/lfc/services/LzBrowser.js
M WEB-INF/lps/lfc/services/LzHistory.as
M WEB-INF/lps/lfc/services/LzStyleSheet.js
M WEB-INF/lps/lfc/services/LzTrack.as
M WEB-INF/lps/lfc/debugger/LzMessage.lzs
M WEB-INF/lps/lfc/debugger/LzDebug.lzs
M WEB-INF/lps/lfc/debugger/platform/swf/LzMemory.as
M WEB-INF/lps/lfc/debugger/platform/swf/LzFlashRemote.as
M WEB-INF/lps/lfc/debugger/platform/swf/kernel.as
M WEB-INF/lps/lfc/debugger/platform/swf/LzRemote.as
M WEB-INF/lps/lfc/debugger/platform/swf/LzDebug.as
M WEB-INF/lps/lfc/debugger/platform/dhtml/LzDebug.js
M WEB-INF/lps/lfc/debugger/platform/dhtml/kernel.js
M WEB-INF/lps/lfc/debugger/LzMonitor.lzs
M WEB-INF/lps/lfc/debugger/LzFormat.lzs
M WEB-INF/lps/lfc/debugger/LzCompiler.lzs
M WEB-INF/lps/lfc/debugger/LzTrace.lzs
M WEB-INF/lps/lfc/debugger/LzBacktrace.lzs
M WEB-INF/lps/lfc/lzpreloader.as
M WEB-INF/lps/lfc/core/LzDictionary.lzs
M WEB-INF/lps/lfc/core/LzNode.lzs
M WEB-INF/lps/lfc/core/LzConstants.lzs
M WEB-INF/lps/lfc/core/UserClass.lzs
M WEB-INF/lps/lfc/core/Class.lzs
M WEB-INF/lps/lfc/core/LzDefs.lzs
M WEB-INF/lps/lfc/glue/LaszloInitiator.lzs
M WEB-INF/lps/lfc/views/LzInputText.lzs
M WEB-INF/lps/lfc/views/LzScript.lzs
M WEB-INF/lps/lfc/views/LzText.lzs
M WEB-INF/lps/lfc/views/LzViewLinkage.lzs
M WEB-INF/lps/lfc/views/platform/swf/LzDrawView.lzs
M WEB-INF/lps/lfc/views/platform/swf/LzContextMenu.lzs
M WEB-INF/lps/lfc/views/platform/swf/LzPlatform.as
M WEB-INF/lps/lfc/views/platform/dhtml/LzDrawView.lzs
M WEB-INF/lps/lfc/views/LaszloView.lzs
M WEB-INF/lps/lfc/views/LaszloCanvas.lzs
M WEB-INF/lps/lfc/LaszloLibrary.lzs
M WEB-INF/lps/lfc/helpers/LzFont.lzs
M WEB-INF/lps/lfc/helpers/LzCommand.lzs
M WEB-INF/lps/lfc/helpers/LzSelectionManager.lzs
M WEB-INF/lps/lfc/helpers/LzState.lzs
M WEB-INF/lps/lfc/events/LaszloEvents.lzs
M WEB-INF/lps/lfc/controllers/LzAnimatorGroup.lzs
M WEB-INF/lps/lfc/controllers/LaszloLayout.lzs
M WEB-INF/lps/lfc/controllers/LaszloAnimation.lzs
M WEB-INF/lps/lfc/data/LzLazyReplicationManager.lzs
M WEB-INF/lps/lfc/data/LzReplicationManager.lzs
M WEB-INF/lps/lfc/data/platform/swf/LzConnectionDatasource.lzs
M WEB-INF/lps/lfc/data/platform/swf/LzConnection.lzs
M WEB-INF/lps/lfc/data/LzDatapointer.lzs
M WEB-INF/lps/lfc/data/LzDataText.lzs
M WEB-INF/lps/lfc/data/LzDataNode.lzs
M WEB-INF/lps/lfc/data/LzDataElement.lzs
M WEB-INF/lps/lfc/data/LzDataset.lzs
M WEB-INF/lps/lfc/data/LzDatapath.lzs
M WEB-INF/lps/lfc/data/LzResizeReplicationManager.lzs
M WEB-INF/lps/lfc/data/LzDatasource.lzs
M WEB-INF/lps/lfc/data/LzHTTPDatasource.lzs
M WEB-INF/lps/lfc/data/LzParsedPath.lzs
M WEB-INF/lps/lfc/data/LzParam.lzs
M WEB-INF/lps/lfc/data/LzDataAttrBind.lzs
M WEB-INF/lps/lfc/compiler/LzRuntime.lzs
M WEB-INF/lps/server/src/org/openlaszlo/js2doc/Schema_Test.java
M WEB-INF/lps/server/src/org/openlaszlo/js2doc/tests/
test_include.xml
M WEB-INF/lps/server/src/org/openlaszlo/js2doc/tests/
LaszloEvents.xml
M WEB-INF/lps/server/src/org/openlaszlo/js2doc/Comment.java
M WEB-INF/lps/server/src/org/openlaszlo/js2doc/JS2Doc_Test.java
M WEB-INF/lps/server/src/org/openlaszlo/js2doc/JS2Doc.java
M WEB-INF/lps/server/src/org/openlaszlo/js2doc/js2doc.rnc
M WEB-INF/lps/server/src/org/openlaszlo/compiler/
ClassCompiler.java
M WEB-INF/lps/server/src/org/openlaszlo/compiler/ViewSchema.java
M WEB-INF/lps/server/src/org/openlaszlo/compiler/NodeModel.java
M WEB-INF/lps/server/build.xml
D docs/src/HTMLPage.py
D docs/src/config.py
D docs/src/HTMLWrapper.py
A + docs/src/contributors
A + docs/src/contributors/book-info.dbk
A + docs/src/contributors/preface.dbk
A + docs/src/contributors/index.dbk
M docs/src/build.xml
D docs/src/XMLDocs.py
D docs/src/categories.txt
D docs/src/tiers.txt
D docs/src/Text.py
D docs/src/element.py
D docs/src/makeXML.py
D docs/src/makeHTML.py
A + docs/src/reference/images
A + docs/src/reference/images/resizelayout
A + docs/src/reference/images/tabelement
A + docs/src/reference/images/basetabs
A + docs/src/reference/images/wrappinglayout
A + docs/src/reference/images/basebutton
A + docs/src/reference/images/stableborderlayout
A + docs/src/reference/images/multistatebutton
A + docs/src/reference/images/simplelayout
A + docs/src/reference/images/tabslider
A + docs/src/reference/images/basetree
A + docs/src/reference/images/view
A + docs/src/reference/images/simpleinputtext
M docs/src/reference/index.dbk
A + docs/src/reference/data
A + docs/src/reference/resources
A + docs/src/reference/resources/autoPng
D docs/src/build/redmond-button.xml
D docs/src/build/redmond-windowtext.xml
D docs/src/build/redmond-radio.xml
D docs/src/build/redmond-tabview.xml
D docs/src/build/redmond-windowframe.xml
D docs/src/build/redmond-menuitem.xml
D docs/src/build/redmond-scrollbar.xml
D docs/src/build/redmond-menu.xml
D docs/src/build/redmond-menuseparator.xml
D docs/src/build/redmond-checkbox.xml
D docs/src/build/redmond-window.xml
D docs/src/build/redmond-combobox.xml
D docs/src/build/redmond-menubar.xml
D docs/src/wrappers/state.html
D docs/src/wrappers/lzmodemanager.html
D docs/src/wrappers/multistatebutton.html
D docs/src/wrappers/basecomponent.html
D docs/src/wrappers/lzcanvasgradient.html
D docs/src/wrappers/connection.html
D docs/src/wrappers/style.html
D docs/src/wrappers/submit.html
D docs/src/wrappers/lzparam.html
D docs/src/wrappers/import.html
D docs/src/wrappers/basetabscontent.html
D docs/src/wrappers/include.html
D docs/src/wrappers/swatchview.html
D docs/src/wrappers/text.html
D docs/src/wrappers/basescrollthumb.html
D docs/src/wrappers/basetree.html
D docs/src/wrappers/lzresizereplicationmanager.html
D docs/src/wrappers/basebuttonrepeater.html
D docs/src/wrappers/hbox.html
D docs/src/wrappers/basedatepickerday.html
D docs/src/wrappers/baselist.html
D docs/src/wrappers/view.html
D docs/src/wrappers/vbox.html
D docs/src/wrappers/dragstate.html
D docs/src/wrappers/lzcursor.html
D docs/src/wrappers/baseform.html
D docs/src/wrappers/basegridcolumn.html
D docs/src/wrappers/splash-view.html
D docs/src/wrappers/images
D docs/src/wrappers/images/resizelayout
D docs/src/wrappers/images/resizelayout/resizelayout_image1.jpg
D docs/src/wrappers/images/resizelayout/resizelayout_image2.jpg
D docs/src/wrappers/images/tabelement
D docs/src/wrappers/images/tabelement/tabelement_image1.jpg
D docs/src/wrappers/images/logo.png
D docs/src/wrappers/images/basetabs
D docs/src/wrappers/images/basetabs/tabs-diagram.gif
D docs/src/wrappers/images/wrappinglayout
D docs/src/wrappers/images/wrappinglayout/
wrappinglayout_image1.jpg
D docs/src/wrappers/images/wrappinglayout/
wrappinglayout_image2.jpg
D docs/src/wrappers/images/basebutton
D docs/src/wrappers/images/basebutton/button-up.png
D docs/src/wrappers/images/basebutton/button-down.png
D docs/src/wrappers/images/basebutton/button-over.png
D docs/src/wrappers/images/stableborderlayout
D docs/src/wrappers/images/stableborderlayout/
stableborderlayout_image1.jpg
D docs/src/wrappers/images/multistatebutton
D docs/src/wrappers/images/multistatebutton/state0-mouseover.jpg
D docs/src/wrappers/images/multistatebutton/state1-mouseover.jpg
D docs/src/wrappers/images/multistatebutton/state0-mouseup.jpg
D docs/src/wrappers/images/multistatebutton/state1-mouseup.jpg
D docs/src/wrappers/images/multistatebutton/state0-mousedown.jpg
D docs/src/wrappers/images/multistatebutton/state1-mousedown.jpg
D docs/src/wrappers/images/simplelayout
D docs/src/wrappers/images/simplelayout/simplelayout1.jpg
D docs/src/wrappers/images/simplelayout/simplelayout2.jpg
D docs/src/wrappers/images/simplelayout/simplelayout3.jpg
D docs/src/wrappers/images/tabslider
D docs/src/wrappers/images/tabslider/tabslider_image1.png
D docs/src/wrappers/images/tabslider/tabslider_image2.png
D docs/src/wrappers/images/basetree
D docs/src/wrappers/images/basetree/basetree-diagram.png
D docs/src/wrappers/images/view
D docs/src/wrappers/images/view/view_image4.jpg
D docs/src/wrappers/images/view/view_image5.jpg
D docs/src/wrappers/images/view/view_image0.jpg
D docs/src/wrappers/images/view/view_image1.jpg
D docs/src/wrappers/images/view/view_image2.jpg
D docs/src/wrappers/images/view/view_image3.jpg
D docs/src/wrappers/images/simpleinputtext
D docs/src/wrappers/images/simpleinputtext/
simpleinputtext_image.jpg
D docs/src/wrappers/basecombobox.html
D docs/src/wrappers/replicationmanager.html
D docs/src/wrappers/event-declaration.html
D docs/src/wrappers/basetabpane.html
D docs/src/wrappers/lzdatatext.html
D docs/src/wrappers/lztimer.html
D docs/src/wrappers/resizestate.html
D docs/src/wrappers/library.html
D docs/src/wrappers/basedatepicker.html
D docs/src/wrappers/resources
D docs/src/wrappers/resources/poof.mp3
D docs/src/wrappers/resources/contactsdata.xml
D docs/src/wrappers/resources/autoPng
D docs/src/wrappers/resources/autoPng/lzwaitcursor_rsc.png
D docs/src/wrappers/resources/lzwaitcursor_rsc.swf
D docs/src/wrappers/basegrid.html
D docs/src/wrappers/lzfocus.html
D docs/src/wrappers/attribute.html
D docs/src/wrappers/script.html
D docs/src/wrappers/basefocusview.html
D docs/src/wrappers/basetabsbar.html
D docs/src/wrappers/basescrollbar.html
D docs/src/wrappers/method.html
D docs/src/wrappers/basedatepickerweek.html
D docs/src/wrappers/lzdatanode.html
D docs/src/wrappers/lzbrowser.html
D docs/src/wrappers/httpdatasource.html
D docs/src/wrappers/lzcontextmenuitem.html
D docs/src/wrappers/lzlazyreplicationmanager.html
D docs/src/wrappers/basetabelement.html
D docs/src/wrappers/basetrackgroup.html
D docs/src/wrappers/command.html
D docs/src/wrappers/basescrolltrack.html
D docs/src/wrappers/lzglobalmouse.html
D docs/src/wrappers/basetabs.html
D docs/src/wrappers/baselistitem.html
D docs/src/wrappers/basevaluecomponent.html
D docs/src/wrappers/basescrollarrow.html
D docs/src/wrappers/data
D docs/src/wrappers/data/columnchart-data-example1.xml
D docs/src/wrappers/data/ebay.xml
D docs/src/wrappers/data/columnchart-data-example2.xml
D docs/src/wrappers/data/ebay1.xml
D docs/src/wrappers/data/ebay1000.xml
D docs/src/wrappers/data/simple-redsox-data.xml
D docs/src/wrappers/data/pie-data.xml
D docs/src/wrappers/data/pie-data2.xml
D docs/src/wrappers/data/simple.xml
D docs/src/wrappers/data/redsox-data.xml
D docs/src/wrappers/data/redsox-data1.xml
D docs/src/wrappers/data/redsox-data2.xml
D docs/src/wrappers/basebutton.html
D docs/src/wrappers/dataselectionmanager.html
D docs/src/wrappers/handler.html
D docs/src/wrappers/baseslider.html
D docs/src/wrappers/baseformitem.html
D docs/src/wrappers/image.html
D docs/src/wrappers/lzidle.html
D docs/src/wrappers/debug.html
D docs/src/wrappers/splash.html
D docs/src/wrappers/basedatacombobox.html
D docs/src/wrappers/basetabslider.html
D docs/src/wrappers/connectiondatasource.html
D docs/src/wrappers/lztrack.html
D docs/src/LZXConcepts.py
D docs/src/xsl/redmond-components.xsl
M docs/src/xsl/synop-javascript.xsl
D docs/src/xsl/reference-nav.xsl
D docs/src/xsl/reference-toc.xsl
A + docs/src/xsl/js2doc-verbose.xsl
M docs/src/xsl/js2doc-comment2dbk.xsl
M docs/src/xsl/js2doc2dbk.xsl
M docs/src/xsl/js2doc2topics.xsl
M docs/src/xsl/js2doc2xref.xsl
M docs/src/xsl/refguide-html.xsl
M docs/src/xsl/common-html.xsl.proto
M docs/src/xsl/parameters.xsl
D docs/src/globals.py
M docs/includes/docbook.css
M docs/index.html
M lps/components/extensions/library.lzx
M lps/components/extensions/av/library.lzx
M lps/components/utils/layouts/library.lzx
M lps/components/utils/library.lzx
M lps/components/utils/states/library.lzx
M lps/components/utils/states/dragstate.lzx
M lps/components/utils/states/resizestate.lzx
M lps/components/library.lzx
M lps/components/charts/library.lzx
M lps/components/charts/addon/library.lzx
M lps/components/charts/common/library.lzx
M lps/components/debugger/library.lzx
M lps/components/rpc/library.lzx
M lps/components/lz/library.lzx
M lps/components/lz/edittext.lzx
M lps/components/lzunit/library.lzx
M lps/components/incubator/custombutton.lzx
M lps/components/incubator/fisheye_lib.lzx
M lps/components/incubator/boxview.lzx
A + lps/components/incubator/library.lzx
M lps/components/incubator/draglib.lzx
M lps/components/incubator/bigcheckbox.lzx
M lps/components/incubator/colorpicker.lzx
M lps/components/incubator/closebox.lzx
M lps/components/incubator/base64.lzx
M lps/components/incubator/tooltipmanager.lzx
M lps/components/incubator/stylishbutton.lzx
M lps/components/incubator/borderinput.lzx
M lps/components/base/datalistselector.lzx
M lps/components/base/basebutton.lzx
M lps/components/base/basegridrow.lzx
M lps/components/base/basetabelement.lzx
M lps/components/base/basescrollbar.lzx
M lps/components/base/image.lzx
M lps/components/base/basedatepickerweek.lzx
M lps/components/base/swatchview.lzx
M lps/components/base/baselistitem.lzx
M lps/components/base/multistatebutton.lzx
M lps/components/base/basetree.lzx
M lps/components/base/componentmanager.lzx
M lps/components/base/basecomponent.lzx
M lps/components/base/basebuttonrepeater.lzx
M lps/components/base/hbox.lzx
M lps/components/base/basewindow.lzx
M lps/components/base/basecombobox.lzx
M lps/components/base/submit.lzx
M lps/components/base/library.lzx
M lps/components/base/basetabslider.lzx
M lps/components/base/basedatepickerday.lzx
M lps/components/base/basefocusview.lzx
M lps/components/base/basedatepicker.lzx
M lps/components/base/baselist.lzx
M lps/components/base/basetrackgroup.lzx
M lps/components/base/baseslider.lzx
M lps/components/base/baseformitem.lzx
M lps/components/base/vbox.lzx
M lps/components/base/basegrid.lzx
M lps/components/base/basetabs.lzx
M lps/components/base/basevaluecomponent.lzx
M lps/components/base/basedatacombobox.lzx
M lps/components/base/baseform.lzx
M lps/components/base/basegridcolumn.lzx
M lps/components/base/style.lzx
Changeset: http://svn.openlaszlo.org/openlaszlo/patches/20070102-
jgrandyw-x.tar
