[Laszlo-dev] For Review: Change 20080801-dda-j Summary: Clean up 'published' lz.* names for services

[Donald Anderson]

This review supercedes the one I sent last week.  Modulo a couple
issues discussed in email, it should be 'complete'.

Change 20080801-dda-j by dda at lester.local on 2008-08-01 17:23:18 EDT
     in /Users/dda/laszlo/src/svn/openlaszlo/trunk
     for http://svn.openlaszlo.org/openlaszlo/trunk

Summary: Clean up 'published' lz.* names for services

New Features:

Bugs Fixed: LPP-6600

Technical Reviewer: ptw (pending)
QA Reviewer: andre (pending)
Doc Reviewer: (pending)

Documentation:

Release Notes:

Details:
     This change set makes sure there are lz.* names for all public  
classes/mixins
     in the LFC namespace, using the rules:
      - if there is a lzx tagname <foo>, the name should be lz.foo,
      - otherwise we publish under the name lz.FooBar for a publicly  
documented class named LzFooBar.
      - if a class is not publicly documented and has no tagname, it  
should not be published.

     By 'publicly documented', we mean that the javadoc preceding the  
class must have
     '@access public', and if there is no @access specifier, the file  
level javadoc
     must have '@access public'.  If these are not the case, the class  
will not be picked
     up by the doc tools.

     To follow these rules, this change set adds some lz.* publish  
statements, and
     removes some statements errantly added before.  The diffs are  
short, so no summary is
     listed here.

     In previous commits, we tracked published names using a //  
publish comment.
     This is not necessary (our tool should find it regardless), but  
we still
     follow this as a convention.

Tests:
     A perl script was used to verify that the correct names were  
published and nothing else.
     That script is attached to LPP-6600 at the moment as it doesn't  
have an official role
     in the build process.  We run it like this:
          $ cd $LPS_HOME/WEB-INF/lps/lfc
          $ verify_published_names -i .
     -i ignores odd cases that are beyond the scope of the tool to  
know about.
     We want the tool to be conservative (report too many rather than  
too few errors).

     Regression: swf8/dhtml smokecheck, swf8/9/dhtml weather/lzpix,  
swf9 hello

Files:
M      WEB-INF/lps/lfc/kernel/swf/LzLibrary.lzs
M      WEB-INF/lps/lfc/kernel/swf/LzFontManager.as
M      WEB-INF/lps/lfc/kernel/swf/LzAudioKernel.as
M      WEB-INF/lps/lfc/kernel/dhtml/LzLibrary.js
M      WEB-INF/lps/lfc/kernel/swf9/LzAudioKernel.lzs
M      WEB-INF/lps/lfc/kernel/swf9/LzXMLTranslator.as
M      WEB-INF/lps/lfc/kernel/swf9/LzXMLParser.as
M      WEB-INF/lps/lfc/kernel/swf9/LzFontManager.as
M      WEB-INF/lps/lfc/kernel/swf9/LzFontManager.lzs
M      WEB-INF/lps/lfc/services/LzTrack.lzs
M      WEB-INF/lps/lfc/services/LzGlobalMouse.lzs
M      WEB-INF/lps/lfc/services/LzKeys.lzs
M      WEB-INF/lps/lfc/services/LzIdle.lzs
M      WEB-INF/lps/lfc/services/LzCursor.lzs
M      WEB-INF/lps/lfc/services/LzModeManager.lzs
M      WEB-INF/lps/lfc/services/LzFocus.lzs
M      WEB-INF/lps/lfc/services/LzTimer.lzs
M      WEB-INF/lps/lfc/services/LzBrowser.lzs
M      WEB-INF/lps/lfc/services/LzHistory.lzs
M      WEB-INF/lps/lfc/services/LzAudio.lzs
M      WEB-INF/lps/lfc/debugger/swf9stubs.lzs
M      WEB-INF/lps/lfc/core/LzNode.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/platform/LzPlatform.lzs
M      WEB-INF/lps/lfc/views/LaszloView.lzs
M      WEB-INF/lps/lfc/views/LaszloCanvas.lzs
M      WEB-INF/lps/lfc/helpers/LzCommand.lzs
M      WEB-INF/lps/lfc/helpers/LzState.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/LzDatapointer.lzs
M      WEB-INF/lps/lfc/data/LzDataText.lzs
M      WEB-INF/lps/lfc/data/LzDataNode.lzs
M      WEB-INF/lps/lfc/data/LzDataRequest.lzs
M      WEB-INF/lps/lfc/data/LzDataProvider.lzs
M      WEB-INF/lps/lfc/data/LzDataset.lzs
M      WEB-INF/lps/lfc/data/LzDatapath.lzs
M      WEB-INF/lps/lfc/data/LzParam.lzs
M      WEB-INF/lps/lfc/data/LzDataAttrBind.lzs
M      WEB-INF/lps/lfc/compiler/LzFormatter.lzs

Changeset: http://svn.openlaszlo.org/openlaszlo/patches/20080801-dda-j.tar


--

Donald Anderson
Systems Developer
dda at laszlosystems.com




-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://www.openlaszlo.org/pipermail/laszlo-dev/attachments/20080806/03d22265/attachment.html