Message-Id: <m0z6gpf-000S4pC@inti.gov.ar>
Comments: Authenticated sender is <salvador AT natacha DOT inti DOT gov DOT ar>
From: "Salvador Eduardo Tropea (SET)" <salvador AT inti DOT gov DOT ar>
Organization: INTI
To: "Rog+rio Guerra Borin" <guerra AT ipt DOT br>, djgpp AT delorie DOT com
Date: Wed, 12 Aug 1998 16:56:15 +0000
MIME-Version: 1.0
Content-type: text/plain; charset=ISO-8859-1
Subject: Re: Generating documentation directly from source file
In-reply-to: <35D1DF98.CBDA1BFC@dce03.ipt.br>
Content-Transfer-Encoding: 8bit
Precedence: bulk

"Rogério Guerra Borin" <guerra AT ipt DOT br> wrote:

> Does somebody know any program that, given a C/C++ source file,
> generates automatically documentation (preferably in HTML format) ?
> 
> For example, I have a C++ source file like this:
> -----------------------------------------------------------------------------
> 
> // [title:"Game Manual"]
> // This is the game manual.
> // [endtitle]
> -----------------------------------------------------------------------------
> 
> and would like to generate a file like:
> 
> -----------------------------------------------------------------------------
> 
>                                                  Game Manual
> 
> This is the game manual.
> -----------------------------------------------------------------------------

SET edit have a module to do something like that but is oriented for 
documenting libraries or large projects.
Basically you divide your stuff in modules or in classes or with any other 
criteria. The you add a comment at the start of each file indicating to what 
module it belongs or what class is defined there. Then you add comments to 
all the functions with a description of what the function does and what 
returns (other items can be customized). You don't need to specify the 
prototype because the SDG gets it from the source, only for inline members is 
needed. 
Finally you ask SDG to generate the documentation and SDG will generate 
indexes by module, class, file, etc with the list of functions in each 
category and a link to a description of each function. SDG will include the 
function prototype, file where the function is located and line taking it 
from the source.

SET
------------------------------------ 0 --------------------------------
Visit my home page: http://set-soft.home.ml.org/
or
http://www.geocities.com/SiliconValley/Vista/6552/
Salvador Eduardo Tropea (SET). (Electronics Engineer)
Alternative e-mail: set-soft AT usa DOT net set AT computer DOT org
ICQ: 2951574
Address: Curapaligue 2124, Caseros, 3 de Febrero
Buenos Aires, (1678), ARGENTINA
TE: +(541) 759 0013