Maybe Lou (cc-ed) could illuminate us.
I'm pretty sure the documentation documentation is quite stale. I
just try to make my new documentation (when I write it) look like what
is already there. But I also have been confused by the different
conventions that I find.
On 2009-08-27, at 15:22EDT, André Bargull wrote:
Is there any guide for js2doc and docbook for the documentation on
classes and methods? For example, currently I'm seeing a whole bunch
of different elements which are used to annotate references to
classes (<code>, <class>, <classname>, <tagname>) and it isn't
obvious which is actually the proper element (in terms of
semantics). The documentation in the Contributor's Guide part of the
Developer's Guide for docbook [1] and js2doc [2] doesn't really
help. I'd like to see a simple guide with instructions where and
when to use which elements.
- André
[1] http://labs.openlaszlo.org/trunk-nightly/docs/developers/docbook-local.html
[2]
http://labs.openlaszlo.org/trunk-nightly/docs/developers/js2doc-reference.html
