Google Groups no longer supports new Usenet posts or subscriptions. Historical content remains viewable.
Dismiss
Structuring jsdoc-toolkit documentation
1 view
Skip to first unread message
Jens Müller
May 22, 2012, 8:58:57 AM5/22/12
to
Hi all,
I am generating JavaScript documentation using jsdoc-toolkit[1]. I have
several "classes" marked with @class that only exist as documentation,
but not as code. The reason for this is that they describe the structure
of data that is loaded from a server as JSON.
This results in quite a number of "classes", which I up to now have
marked by using a common prefix. Nevertheless, the list of types in the
generated documentation becomes considerably longer because of them. Is
there a possibility to structure the documentation somehow, using some
kind of packages or namespaces? Possibly there is a documentation
generator that can do this and is mostly compatible to the documentation
tags used by jsdoc-toolkit?
Thanks a lot!
Cheers,
Jens
[1] http://code.google.com/p/jsdoc-toolkit/
I am generating JavaScript documentation using jsdoc-toolkit[1]. I have
several "classes" marked with @class that only exist as documentation,
but not as code. The reason for this is that they describe the structure
of data that is loaded from a server as JSON.
This results in quite a number of "classes", which I up to now have
marked by using a common prefix. Nevertheless, the list of types in the
generated documentation becomes considerably longer because of them. Is
there a possibility to structure the documentation somehow, using some
kind of packages or namespaces? Possibly there is a documentation
generator that can do this and is mostly compatible to the documentation
tags used by jsdoc-toolkit?
Thanks a lot!
Cheers,
Jens
[1] http://code.google.com/p/jsdoc-toolkit/
0 new messages