On Mar 8, 2007, at 10:43 AM, John Sundman wrote:
I thought the convention for class names was going to be lz.foo
(note lowercase lz and .)
It was, assuming I have time to make that rather large change to the
doc tools before we ship. I wouldn't bet on me having that time :-)
I will commit to mentioning the lz.foo form in the preface (yet to be
written), and *may* be able to add a notation to each refguide page
mentioning the lz.foo form. But I don't think I have time to replace
all mentions of LzFoo with lz.foo.
So the docs should say, for example, lz.script not LzScript, as in
the current case.
If my understanding is correct, then both forms work, but the
lz.foo form is to be preferred. Is this the case?
The examples in the documentation have not been updated to the
lz.foo form. However, that is the form that I have explained is
the cannonical normal form. Am I correct about that? And if so,
can the doc tools be changed to render the class names according to
the lz.foo form?
Thanks for any clarificaiton.
jrs
On Mar 8, 2007, at 12:30 PM, Jim Grandy wrote:
Thanks!
On Mar 7, 2007, at 10:38 PM, Max Carlson wrote:
http://localhost:8080/legals-clean/docs/reference/
LzInstantiator.html
I can add a note to see LzInstantiatorClass for more details. Or
perhaps the two should just be private?
http://localhost:8080/legals-clean/docs/reference/LzScript.html
has a when="immediate" attribute
http://localhost:8080/legals-clean/docs/reference/tag.splash.html
is swf-only. The dhtml splash is all controlled in the wrapper.
Done.
http://localhost:8080/legals-clean/docs/reference/tag.splash-
view.html
is swf-only
Done.
http://localhost:8080/legals-clean/docs/reference/Lz.html
should not show __dhtmlhistoryready
Done.
http://localhost:8080/legals-clean/docs/contributors/LzTextSprite
+dhtml.html and friends are missing the JS synopsis. Also, how
can I add the constructor docs there?
For the description, add a /** ... */ comment just before the 'var
LzTextSprite' line. This is an old-style JS class, so since the
function is the constructor there's no separate constructor doc.
/** LzText sprite description blah blah
*
* @param owner: the text sprite's parent sprite
*/
--
Regards,
Max Carlson
OpenLaszlo.org
