Forum OpenACS Q&A: Auto-generation of API docs

Collapse
1: Auto-generation of API docs
Posted by Chris Hodgson on 08/29/02 10:13 PM
I've have created a new package, which is a OpenACS Service, and I
have written my code using all of the documentation techniques which
are described in the OACS 4.5 docs (all the javadoc-style @ tags and
descriptions). Is there a tool to auto-generate the API documentation
for my package?
Collapse
2: Response to Auto-generation of API docs (response to 1)
Posted by Roberto Mello on 08/29/02 10:24 PM
I'm afraid not yet, but it's in my personal TODO-soon list. If you have time and would like to tackle that, we would use it in the entire project's documentation.
Collapse
3: Response to Auto-generation of API docs (response to 1)
Posted by Don Baccus on 08/30/02 01:26 AM
But you should be able to browse them with the API browser.  This requires you be running an OpenACS instance (and probably requires that all the tcl files be in the package .info file) but it's better than nothing ...
Collapse
4: Response to Auto-generation of API docs (response to 1)
Posted by Roberto Mello on 08/30/02 05:10 AM
Don, yes of course they should be browseable through the API browser. But there are a number of situations where it's useful to have a static HTML version of the docs available, and that's what I plan to make available.
Collapse
5: Response to Auto-generation of API docs (response to 1)
Posted by Andrei Popov on 08/30/02 04:49 PM
On a somewhat related issue -- how do I get (manually prepared) docs for local package to appear in Core Documentation? I.e. how does a <package>/www/doc gets included into /doc hierarchy?