comp.lang.ada
 help / color / mirror / Atom feed
From: Michael Erdmann <Michael.Erdmann@snafu.de>
To: Robert Dewar <dewar@gnat.com>
Subject: Re: Q: Generating Documenation from Ada Sources?
Date: Sat, 11 May 2002 21:07:03 +0200
Date: 2002-05-11T21:07:03+02:00	[thread overview]
Message-ID: <3CDD6BD7.5010503@snafu.de> (raw)
In-Reply-To: 5ee5b646.0205111029.3cde679@posting.google.com

Robert Dewar wrote:
> Michael Erdmann <Michael.Erdmann@snafu.de> wrote in message news:<3CDD31D7.2060005@snafu.de>...
> 
>>I am looking for open source tools which are
>>generating documentation out of package
>>specifications.
>>Such a tools sould not just list the items
>>in the specification but also extract the
>>comments belonging to these items into a
>>resonable format.
>>
>>Who knows more about the topic?
>>
>>Michael
> 
> 
> 
> For a well written Ada spec, it would seem that the unix tool cat would
> do what you want, or possibly something like gnathtml. I think you need
> to be a whole lot more specific about what you are looking for. What else
> is there in a spec except items and comments?


The point is that Ada spec. come along with
coments which expalains certain aspects of
an interface.
I like to generate from the *.ads file a
docbook (sgml) formated manual page which
contains the explanatory text. This mean
for example the package name goes into the
section name, the description into a
paragraph, the spec. it self goes into
a program listing section.

I guess i am not the first one having
such a problem!


Michael







  reply	other threads:[~2002-05-11 19:07 UTC|newest]

Thread overview: 16+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2002-05-11 14:59 Q: Generating Documenation from Ada Sources? Michael Erdmann
2002-05-11 18:29 ` Robert Dewar
2002-05-11 19:07   ` Michael Erdmann [this message]
2002-05-12  2:05     ` Randy Brukardt
2002-05-12  7:35       ` Michael Erdmann
2002-05-12  8:12         ` Dr. Michael Paus
2002-05-12 15:23           ` Michael Erdmann
2002-05-12 17:49             ` tmoran
2002-05-12 20:43               ` Ira D. Baxter
2002-05-13 14:11             ` Stephen Leake
2002-05-13 20:21               ` Michael Erdmann
2002-05-13 22:25                 ` tmoran
2002-05-14 18:01                   ` Michael Erdmann
2002-05-13  5:36 ` Stefan Revets
2002-05-13 13:03   ` Georg Bauhaus
2002-05-14  5:20     ` Stefan Revets
replies disabled

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox