"Javadoc" for Ada

"Javadoc" for Ada

[Joseph P Vlietstra]

Our company is currently using a home-grown documentation generation
tool that extracts comments from preambles preceding each Ada function/
procedure.  The tool is written in C++ and generates MIF (FrameMaker
Interchange Format) files.

We recently updated our C/C++ preamble standards to be closer to Java
doc comments and use Doxygen (Javadoc for C++) to generate documentation.
We are considering changing our Ada preamble standards in a similar
manner.  Are there any doc comment utilities for Ada similar?

Re: "Javadoc" for Ada

[tmoran]

> Are there any doc comment utilities for Ada similar?
  We too have a homegrown utility for documentation.  It parses so in
addition to copying specs and comments, it can link types to their
declarations and uses, as well as parents and children.  It generates
an intermediate form so that a "mail-merge" kind of operation can
override/expand the mechanically generated stuff with manually
created text, to create input to the final .rtf/.htm generator.
  How do other people handle the problem?

Re: "Javadoc" for Ada

[Dr. Michael Paus]

Joseph P Vlietstra wrote:
> 
> Our company is currently using a home-grown documentation generation
> tool that extracts comments from preambles preceding each Ada function/
> procedure.  The tool is written in C++ and generates MIF (FrameMaker
> Interchange Format) files.
> 
> We recently updated our C/C++ preamble standards to be closer to Java
> doc comments and use Doxygen (Javadoc for C++) to generate documentation.
> We are considering changing our Ada preamble standards in a similar
> manner.  Are there any doc comment utilities for Ada similar?

I am not aware of anything like this for Ada but I would be interested to
know if you find something.

Michael

Re: "Javadoc" for Ada

[Florian Weimer]

Joseph P Vlietstra <joevl@concentric.net> writes:

> We recently updated our C/C++ preamble standards to be closer to Java
> doc comments and use Doxygen (Javadoc for C++) to generate documentation.
> We are considering changing our Ada preamble standards in a similar
> manner.  Are there any doc comment utilities for Ada similar?

We use an ASIS-based tool for generating documentation.  It extracts
the documentation from comments, and automatically adds documented
entities to the proper index.  Texinfo is the markup language.  The
system is not comparable to JavaDoc, however, because it does not
enforce structure in the documentation comments.

We plan to release this tool under the GPL, but we have to sort out a
few things first.

Re: "Javadoc" for Ada

[Simon Wright]

tmoran@acm.org writes:

>   We too have a homegrown utility for documentation.  It parses so in
> addition to copying specs and comments, it can link types to their
> declarations and uses, as well as parents and children.  It generates
> an intermediate form so that a "mail-merge" kind of operation can
> override/expand the mechanically generated stuff with manually
> created text, to create input to the final .rtf/.htm generator.
>   How do other people handle the problem?

That sounds neat (though for informal use I'd find gnathtml more than
adequate).

We're generating code frameworks (well, at the higher levels of the
architecture) from UML, so we're generating documentation from the
model.

Re: "Javadoc" for Ada

[Frode Tennebø]

On Sunday 13 January 2002 08:24 Joseph P Vlietstra wrote:

> Are there any doc comment utilities for Ada similar?

Take a look at: http://sourceforge.net/projects/adadoc/

It's mostly in french.

 -Frode
-- 
^ Frode Tenneb� | email: frode@tennebo.com | Frode@IRC ^
|  with Standard.Disclaimer; use Standard.Disclaimer;  |

Re: "Javadoc" for Ada

[Rolf Ebert]

Joseph P Vlietstra <joevl@concentric.net> wrote in message news:<3C413630.A2CEB446@concentric.net>...
> Are there any doc comment utilities for Ada similar?

Have a look at GtkAda (http://libre.act-europe.fr/GtkAda/).  In the
source distribution is a Perl script that extracts the structured
comments (similar to javadoc) and generates a texinfo file.


    Rolf