Program similar to Javadocs, except with manual data entry

miguel_sanchez · 13th March 2008, 12:53 PM

Hi guys,

I'm trying to find myself a program/web template which i can use to manually enter the data similar to the way the Java JavaDocs work (list of classes, select a class it shows functions/members, click one of those it gives a description).

Now i've poked around on Google and Sourceforge but most of the tools out there seem to be aimed at specific languages and automatically generating the information. I want to be able to manually update the classes/functions/members myself (and ideally have a "version" or similar one level above the classes to make it inline with what i develop in)

Does anyone know of a free program i could use to do this?

Thanks.

akashra · 13th March 2008, 1:39 PM

http://www.naturaldocs.org/

miguel_sanchez · 13th March 2008, 5:26 PM

Yeah i've seen that before, but after a (very short) play with it i can't figure out how it works.

As like many other packages, it seems to want to run over source code and create the pages from that. I want an interface to manually add everything.

I'll keep playing in my spare minutes though, thanks for the suggestion.

Foliage · 13th March 2008, 5:35 PM

What's stopping you from just putting the comments in your source files and generating it like everyone else?

miguel_sanchez · 13th March 2008, 5:41 PM

Couple of reasons:

Source is in a database, not in text files (Can get it out if need be though)
There are no comments for the vast majority of classes/functions

So i have to do everything from scratch, and rather than doing it in my crappy 4GL development environment (in an editor which is about as powerful as notepad, in some instances less powerful) i'd try and find a nicer way of doing it all.

Foliage · 13th March 2008, 8:16 PM

Well I guess you could just fire bomb whoever wrote the codes house?

Undocumented code ftl.

13th March 2008, 12:53 PM	#1
miguel_sanchez Member Join Date: Jul 2003 Location: Sydney Posts: 1,120	Program similar to Javadocs, except with manual data entry Hi guys, I'm trying to find myself a program/web template which i can use to manually enter the data similar to the way the Java JavaDocs work (list of classes, select a class it shows functions/members, click one of those it gives a description). Now i've poked around on Google and Sourceforge but most of the tools out there seem to be aimed at specific languages and automatically generating the information. I want to be able to manually update the classes/functions/members myself (and ideally have a "version" or similar one level above the classes to make it inline with what i develop in) Does anyone know of a free program i could use to do this? Thanks.

13th March 2008, 1:39 PM	#2
akashra Member Join Date: Apr 2003 Location: Melbourne, AU Posts: 3,324	http://www.naturaldocs.org/ __________________ Punctuation is the difference between "Let's eat, grandma!" and "Let's eat grandma!". Building a Metricon Delta 21 in Craigieburn: http://homeofzero.blogspot.com/

13th March 2008, 5:35 PM	#4
Foliage Member Join Date: Jan 2002 Location: Sleepwithyourdadelaide Posts: 23,650	What's stopping you from just putting the comments in your source files and generating it like everyone else? __________________ I like to construct strong views on random things, and then argue for absolutely no reason about them.

13th March 2008, 5:41 PM	#5
miguel_sanchez Member Join Date: Jul 2003 Location: Sydney Posts: 1,120	Couple of reasons: Source is in a database, not in text files (Can get it out if need be though) There are no comments for the vast majority of classes/functions So i have to do everything from scratch, and rather than doing it in my crappy 4GL development environment (in an editor which is about as powerful as notepad, in some instances less powerful) i'd try and find a nicer way of doing it all.

13th March 2008, 8:16 PM	#6
Foliage Member Join Date: Jan 2002 Location: Sleepwithyourdadelaide Posts: 23,650	Well I guess you could just fire bomb whoever wrote the codes house? Undocumented code ftl. __________________ I like to construct strong views on random things, and then argue for absolutely no reason about them.

13th March 2008, 5:26 PM	#3
miguel_sanchez Member Join Date: Jul 2003 Location: Sydney Posts: 1,120	Yeah i've seen that before, but after a (very short) play with it i can't figure out how it works. As like many other packages, it seems to want to run over source code and create the pages from that. I want an interface to manually add everything. I'll keep playing in my spare minutes though, thanks for the suggestion.