comp.lang.ada
 help / color / mirror / Atom feed
From: Maciej Sobczak <see.my.homepage@gmail.com>
Subject: Re: Doxygen for Ada
Date: Tue, 21 Jul 2009 01:07:07 -0700 (PDT)
Date: 2009-07-21T01:07:07-07:00	[thread overview]
Message-ID: <cd6d6d22-0be7-4646-b3ae-377793c55daa@c29g2000yqd.googlegroups.com> (raw)
In-Reply-To: 92ed2215-f451-4ca7-b40d-2cb8bf27ba50@b15g2000yqd.googlegroups.com

On 20 Lip, 17:38, Pablo <pablit...@gmail.com> wrote:

> Does someone knows some Doxygen documentation script which runs over
> Ada code?

I have written a script that generates pretty nice docs in the Doxygen/
Javadoc/etc. style, but it works differently from other tools. Instead
of analyzing the code on the ASIS level it assumes that the source
code is "well formatted" and processes it based on the vertical and
horizontal whitespace patterns. Due to the regular structure of the
Ada grammar the whole task is reduced to simple regexp crunching
without any serious compile-like analysis - and is therefore blazing
fast.
I don't claim that its language coverage is complete, but it proved to
be very useful.

The script generates a set of HTML pages with indexes and stuff.

As pointed above, it works *only* when the code is "well formatted",
which means that newlines and indentation should be used according to
common conventions. Fortunately, most of the Ada code that was ever
written is well formatted in this sense. I was able to use this script
for the libraries that come with GNAT, and also for AWS, PolyORB, etc.

Please contact me privately (do not use the mail address in this post,
it is just a spam trap - follow the links in the signature instead) if
you are interested in this script. If there will be a wider interest I
will publish it on the web.

--
Maciej Sobczak * www.msobczak.com * www.inspirel.com

Database Access Library for Ada: www.inspirel.com/soci-ada



  parent reply	other threads:[~2009-07-21  8:07 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2009-07-20 15:38 Doxygen for Ada Pablo
2009-07-20 18:50 ` okellogg
2009-07-22 12:13   ` Chrono
2009-07-21  8:07 ` Maciej Sobczak [this message]
2009-07-22 12:14   ` Chrono
2009-07-24 18:02   ` Chrono
replies disabled

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