If _I_ ran the zoo, I would have a flag day, where we changed the default sense of the @access flag to private, and made everyone go around and mark what we _really_ want to be the public API of OL to be public.
More bugs and dissatisfaction seems to be derived from API's that 'accidentally' were published than I care to think about. At one point, you could make an attribute read-only by saying `setter=""`, and the doc tools would pick that up (and the compiler would have the information to try to do something about it at runtime). IMBN to add a property `access` to attribute, so one could say: <attribute access="public" ... and have both the doc and compiler do the right thing with that. Maybe if we are clever, we can trick Don into doing that as a part of his work (should we be so lucky as to get him back on board). On 2011-01-10, at 13:10, André Bargull wrote: > No problem, I still got the copy, thanks. > > I've only asked for the copy because I couldn't repro the warning at first (I > only did a quick-build of the reference). But after running the complete > reference ant task, I was able to reproduce the warnings. They're caused by > the "publishing" of classes into the lz-namespace in the LFC, that means all > lines like: >> lz.Event = LzEvent; > > This isn't actually a new bug, I've got a local log file from May 2010 with > the same warnings. You may just create a bug report at JIRA for this issue. > > Some background: > The doc tool wants to inform you that I cannot infer the correct "Category" > of an attribute (see [1], all attributes are of "unknown" category). This is > the offending condition in js2doc2dbk.xsl: >> <xsl:when test="not(&unwritable;) and not($isinstancevar) and >> not($issetter)"> > > The attributes on "lz" aren't marked as read-only, so the first condition > "not(&unwritable;)" yields true. They also aren't instance allocated > attributes, so "not($isinstancevar)" yields true, too. And they aren't > setters, so "not($issetter)" also yields true. That means marking all publish > statements as read-only will remove the warnings: >> /** @keywords read-only */ >> lz.Event = LzEvent; > > (Is read-only the right category for the entries of "lz"?) > > --- > > There are some more warnings for the new html5 mediaview class, we should > teach Henry (cc-ed) to write proper jsdocs :-) >> [xslt] Unknown attribute category (no setter) for : HAVE_CURRENT_DATA >> [xslt] Unknown attribute category (no setter) for : HAVE_FUTURE_DATA >> [xslt] Unknown attribute category (no setter) for : HAVE_NOTHING > >> <!--- HAVE_NOTHING No media data is available for playback at the current >> time. @keywords private --> >> <attribute name="HAVE_NOTHING" allocation="class" value="0"/> > > jsdocs are line based, new keywords must appear at the line beginning: >> <!--- HAVE_NOTHING No media data is available for playback at the current >> time. >> @keywords private --> >> <attribute name="HAVE_NOTHING" allocation="class" value="0"/> > > And proper read-only attributes are marked as follows: >> <!--- The ready state of the media resource. (read-only) --> >> <attribute name="readyState" /> > > That should be >> <!--- The ready state of the media resource. >> @keywords read-only --> >> <attribute name="readyState" /> > > Or alternatively "@keywords readonly", "@modifiers read-only" or "@modifiers > readonly" (a bit too much alternatives!?)... > > > > [1] http://labs.openlaszlo.org/trunk-nightly/docs/reference/lz.html > > > On 1/10/2011 6:29 PM, Lou Iorio wrote: >> I sent this and it bounced: >> >> Your mail to 'Laszlo-reviews' with the subject >> >> Re: [Laszlo-reviews] build errors >> >> Is being held until the list moderator can review it for approval. >> >> The reason it is being held: >> >> Message body is too big: 3927014 bytes with a limit of 40 KB >> >> Either the message will get posted to the list, or you will receive >> notification of the moderator's decision. If you would like to cancel >> this posting, please visit the following URL: >> >> On Mon, Jan 10, 2011 at 12:57 PM, André Bargull <[email protected] >> <mailto:[email protected]>> wrote: >> >> Can you send a copy of the >> docs/src/build/reference/LaszloLibrary-verbose.js2doc file for >> inspection? >> >> >> >> dbk.topic.generate: >> [echo] visibility.filter is public >> [xslt] Processing >> >> /Users/louisiorio/src/svn/openlaszlo/trunk/docs/src/build/reference/LaszloLibrary-verbose.js2doc >> to >> >> /Users/louisiorio/src/svn/openlaszlo/trunk/docs/src/build/reference/lzxref.dbk >> [xslt] Loading stylesheet >> >> /Users/louisiorio/src/svn/openlaszlo/trunk/docs/src/xsl/js2doc2topics.xsl >> [xslt] >> >> /Users/louisiorio/src/svn/openlaszlo/trunk/docs/src/xsl/js2doc2dbk.xsl:1581:26: >> Warning! >> [xslt] Unknown attribute category (no setter) >> for : Audio >> [xslt] >> >> /Users/louisiorio/src/svn/openlaszlo/trunk/docs/src/xsl/js2doc2dbk.xsl:1581:26: >> Warning! >> [xslt] Unknown attribute category (no setter) >> for : AudioService >> [xslt] >> >> /Users/louisiorio/src/svn/openlaszlo/trunk/docs/src/xsl/js2doc2dbk.xsl:1581:26: >> Warning! >> [xslt] Unknown attribute category (no setter) >> for : Browser >> [xslt] >> >> /Users/louisiorio/src/svn/openlaszlo/trunk/docs/src/xsl/js2doc2dbk.xsl:1581:26: >> Warning! >> [xslt] Unknown attribute category (no setter) >> for : BrowserService >> [xslt] >> >> /Users/louisiorio/src/svn/openlaszlo/trunk/docs/src/xsl/js2doc2dbk.xsl:1581:26: >> Warning! >> [xslt] Unknown attribute category (no setter) >> for : colors >> [xslt] >> >> /Users/louisiorio/src/svn/openlaszlo/trunk/docs/src/xsl/js2doc2dbk.xsl:1581:26: >> Warning! >> [xslt] Unknown attribute category (no setter) >> for : CSSStyleSheet >> [xslt] >> >> /Users/louisiorio/src/svn/openlaszlo/trunk/docs/src/xsl/js2doc2dbk.xsl:1581:26: >> Warning! >> [xslt] Unknown attribute category (no setter) >> for : Cursor >> [xslt] >> >> /Users/louisiorio/src/svn/openlaszlo/trunk/docs/src/xsl/js2doc2dbk.xsl:1581:26: >> Warning! >> [xslt] Unknown attribute category (no setter) >> for : CursorService >> [xslt] >> >> /Users/louisiorio/src/svn/openlaszlo/trunk/docs/src/xsl/js2doc2dbk.xsl:1581:26: >> Warning! >> [xslt] Unknown attribute category (no setter) >> for : DataElement >> [xslt] >> >> /Users/louisiorio/src/svn/openlaszlo/trunk/docs/src/xsl/js2doc2dbk.xsl:1581:26: >> Warning! >> [xslt] Unknown attribute category (no setter) >> for : DataElementMixin >> [xslt] >> >> /Users/louisiorio/src/svn/openlaszlo/trunk/docs/src/xsl/js2doc2dbk.xsl:1581:26: >> Warning! >> [xslt] Unknown attribute category (no setter) >> for : DataNode >> [xslt] >> >> /Users/louisiorio/src/svn/openlaszlo/trunk/docs/src/xsl/js2doc2dbk.xsl:1581:26: >> Warning! >> [xslt] Unknown attribute category (no setter) >> for : DataNodeMixin >> [xslt] >> >> /Users/louisiorio/src/svn/openlaszlo/trunk/docs/src/xsl/js2doc2dbk.xsl:1581:26: >> Warning! >> [xslt] Unknown attribute category (no setter) >> for : DataProvider >> [xslt] >> >> /Users/louisiorio/src/svn/openlaszlo/trunk/docs/src/xsl/js2doc2dbk.xsl:1581:26: >> Warning! >> [xslt] Unknown attribute category (no setter) >> for : DataRequest >> [xslt] >> >> /Users/louisiorio/src/svn/openlaszlo/trunk/docs/src/xsl/js2doc2dbk.xsl:1581:26: >> Warning! >> [xslt] Unknown attribute category (no setter) >> for : DataText >> [xslt] >> >> /Users/louisiorio/src/svn/openlaszlo/trunk/docs/src/xsl/js2doc2dbk.xsl:1581:26: >> Warning! >> [xslt] Unknown attribute category (no setter) >> for : Delegate >> [xslt] >> >> /Users/louisiorio/src/svn/openlaszlo/trunk/docs/src/xsl/js2doc2dbk.xsl:1581:26: >> Warning! >> [xslt] Unknown attribute category (no setter) >> for : Event >> [xslt] >> >> /Users/louisiorio/src/svn/openlaszlo/trunk/docs/src/xsl/js2doc2dbk.xsl:1581:26: >> Warning! >> [xslt] Unknown attribute category (no setter) >> for : Eventable >> [xslt] >> >> /Users/louisiorio/src/svn/openlaszlo/trunk/docs/src/xsl/js2doc2dbk.xsl:1581:26: >> Warning! >> [xslt] Unknown attribute category (no setter) >> for : Focus >> [xslt] >> >> /Users/louisiorio/src/svn/openlaszlo/trunk/docs/src/xsl/js2doc2dbk.xsl:1581:26: >> Warning! >> [xslt] Unknown attribute category (no setter) >> for : FocusService >> [xslt] >> >> /Users/louisiorio/src/svn/openlaszlo/trunk/docs/src/xsl/js2doc2dbk.xsl:1581:26: >> Warning! >> [xslt] Unknown attribute category (no setter) >> for : Font >> [xslt] >> >> /Users/louisiorio/src/svn/openlaszlo/trunk/docs/src/xsl/js2doc2dbk.xsl:1581:26: >> Warning! >> [xslt] Unknown attribute category (no setter) >> for : GlobalMouse >> [xslt] >> >> /Users/louisiorio/src/svn/openlaszlo/trunk/docs/src/xsl/js2doc2dbk.xsl:1581:26: >> Warning! >> [xslt] Unknown attribute category (no setter) >> for : GlobalMouseService >> [xslt] >> >> /Users/louisiorio/src/svn/openlaszlo/trunk/docs/src/xsl/js2doc2dbk.xsl:1581:26: >> Warning! >> >>
