Structuring jsdoc-toolkit documentation

Path	csiph.com!usenet.pasdenom.info!news.albasani.net!fu-berlin.de!uni-berlin.de!individual.net!not-for-mail
From	Jens Müller <usenet-03-2009@tessarakt.de>
Newsgroups	comp.lang.javascript
Subject	Structuring jsdoc-toolkit documentation
Date	Tue, 22 May 2012 14:58:57 +0200
Lines	22
Message-ID	<a21gsiF8psU1@mid.individual.net> (permalink)
Mime-Version	1.0
Content-Type	text/plain; charset=ISO-8859-1; format=flowed
Content-Transfer-Encoding	7bit
X-Trace	individual.net NJUJdnt3ThaMBhgnkyrArgvOJBlog8/jeqbHoX94SpmonjTNF6USjMnd4NGUcHF68=
Cancel-Lock	sha1:Yl9JtVsYFadZCEtY5SpqGHA2ojU=
User-Agent	Mozilla/5.0 (Windows NT 6.1; rv:14.0) Gecko/20120521 Thunderbird/14.0a2
Xref	csiph.com comp.lang.javascript:14088

Show key headers only | View raw

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/

Back to comp.lang.javascript | Previous | Next | Find similar | Unroll thread

Thread

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

csiph-web