javadoc like system for C wanted

Sumo Wrestler (or just ate too much)

unread,

Apr 18, 2006, 10:40:09 PM4/18/06

to

I'm looking for some opensource software that will allow me to embed
documentation into C source files--similar to the way javadoc allows
documentation inside of Java source files.

Cweb, funnelweb and noweb are not what I'm looking for because they
require that the programmer write in a language other than C. I want to
write in C, not in web.

This is what I'm looking for:

/*********************************************
* gobble - gobble some characters from a string
*
* param: str - the string to work on
* param: pos - the initial position in the string to start
* gobbling
* param: stopped - "points" to the next character in str
* to do more gobbling on
*
* Returns: (through the stopped parameter)
* If there are more characters to gobble, an index
* to the next character in str to gobble.
* If there are no more characters to gobble, -1.
**********************************************/

void gobble (const char * str, int pos, int * stopped)
{
...
}

Then I want to execute the tool to create the documentation for the
functions in my C source file:

$ tool gobble.c
--> tool: wrote gobble.html

I hope that something like this already exists. Preferably it would be
free (even opensource), and optimally I could install it using apt-get :)

Patrick TJ McPhee

unread,

Apr 19, 2006, 10:51:14 PM4/19/06

to

In article <4alm89F...@uni-berlin.de>,
Sumo Wrestler (or just ate too much) <sumo.w...@microsoft.invalid> wrote:

% I'm looking for some opensource software that will allow me to embed
% documentation into C source files--similar to the way javadoc allows
% documentation inside of Java source files.

You might want doc++ (http://docpp.sourceforge.net).

% Cweb, funnelweb and noweb are not what I'm looking for because they
% require that the programmer write in a language other than C. I want to
% write in C, not in web.

More to the point, litprog tools are not geared towards producing
canned documentation. They're meant to facilitate a method of writing
programs.

--

Patrick TJ McPhee
North York Canada
pt...@interlog.com

Thomas Maier-Komor

unread,

Apr 19, 2006, 10:52:17 PM4/19/06

to

Have you tried doxygen?

Tom

dani...@mclink.it

unread,

Apr 19, 2006, 10:56:30 PM4/19/06

to

Sumo Wrestler (or just ate too much) wrote:

--

Have you tried Doxygen?
It is open source:
http://www.stack.nl/~dimitri/doxygen/download.html#latestsrc
They have versions for Windows and various Linux
distributions, including Debian:
http://www.stack.nl/~dimitri/doxygen/download.html#rpm

A descendant of Doxygen is doxys, which you can find with sources at:

http://www.doxys.dk/homepage/Download/Download0_dir_description.html

Another similar tool is DOC++: http://docpp.sourceforge.net/
For this you'll find sources and some binaries at:
http://docpp.sourceforge.net/download.html
although just RPM's are available for Linux.

The syntax for these tools is not exactly the one you suggested, but
comes quite close, and definitely isn't web-like.
HTH.

____________________________________________________________________________

Danilo Coccia email: daniloco 'at' acm 'dot' org
Via Cherubini 1 daniloco 'at' mclink 'dot'
it 20090 Buccinasco Phone: +39-0245712469
Italy
____________________________________________________________________________

Thomas Maier-Komor

unread,

Apr 24, 2006, 11:24:21 PM4/24/06

to

Sumo Wrestler (or just ate too much) wrote:

Have you tried doxygen?

Tom

dani...@mclink.it

unread,

Apr 24, 2006, 11:24:35 PM4/24/06

to

Sumo Wrestler (or just ate too much) wrote:

--

Sumo Wrestler (or just ate too much)

unread,

Apr 25, 2006, 10:24:44 PM4/25/06

to

Thomas Maier-Komor wrote:
> Sumo Wrestler (or just ate too much) wrote:
>> I'm looking for some opensource software that will allow me to embed

>> documentation into C source files [...]
>
> Have you tried doxygen?
>

And
dani...@mclink.it wrote:
>
> Have you tried Doxygen? [...]

Thanks guys!
I did an "apt-get doxygen," and it works great.