comp.lang.ada
 help / color / mirror / Atom feed
From: "Dr. Michael Paus" <paus@ib-paus.com>
Subject: Re: Q: Generating Documenation from Ada Sources?
Date: Sun, 12 May 2002 10:12:52 +0200
Date: 2002-05-12T08:12:53+00:00	[thread overview]
Message-ID: <3CDE2404.5030008@ib-paus.com> (raw)
In-Reply-To: 3CDE1B39.9060000@snafu.de

Michael Erdmann wrote:
> Randy Brukardt wrote:
> 
>> Michael Erdmann wrote in message <3CDD6BD7.5010503@snafu.de>...
>>
>>> 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!
>>
>>
>>
>>
>> We developed such a tool for creating the Claw documents (it outputs
>> HTML and .RTF for WinHelp), but its not open source and its rather tied
>> to our Claw coding conventions. 
> 
> 
> I gues this is important to note, that i have to come up with
> some kind of convention how the text is formated in order to
> map the text into docbook.
> 
> I am wondering if it makes sense to add the commentary text already
> in tagged format into the source. Any experiences on this?

It sounds as if you are looking for something like JavaDoc (for Ada).
Hava you tried AdaBrowse? (http://home.datacomm.ch/t_wolf/tw/ada95/adabrowse/)
I have not had the time to try it out but it is supposed to do what you want.

Michael




  reply	other threads:[~2002-05-12  8:12 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
2002-05-12  2:05     ` Randy Brukardt
2002-05-12  7:35       ` Michael Erdmann
2002-05-12  8:12         ` Dr. Michael Paus [this message]
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