Groups | Search | Server Info | Keyboard shortcuts | Login | Register [http] [https] [nntp] [nntps]

Groups > comp.lang.javascript > #14088 > unrolled thread

Structuring jsdoc-toolkit documentation

Back to article view | Back to comp.lang.javascript

Contents

  Structuring jsdoc-toolkit documentation Jens Müller <usenet-03-2009@tessarakt.de> - 2012-05-22 14:58 +0200

#14088 — Structuring jsdoc-toolkit documentation

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/

[toc] | [standalone]

Back to top | Article view | comp.lang.javascript

csiph-web