Re: Q: Generating Documenation from Ada Sources?

[Michael Erdmann <Michael.Erdmann@snafu.de>]

Dr. Michael Paus wrote:
> 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.
> 
Thanks i have tried it. What i am interested is more centered on
processing text in the source. Your browser does not care about
the contents of the comments. It is left to the used to build in
tags or not.

What i am looking for i a tool which maps the relevant part of the
coments in a package spec. and transforms this into a docbook document.
In order to do so such a program requieres certain key words.
Theretically the comment in the source could already contain
docbook format but i dont like the idea, since the comments
are getting unreadable.
I gues what i am looking for i a tool which is abble to retrieve
sections identified by headlines from normal and to convert it
into docbook format. Copying in the specification of a procedure
is the minor part of it.

Any way, adabrowser is based on asis, which requieres that the module
is compilable which i cannot gurantee.

Michael


> Michael
>