Prev: Conversion from Ada95 to Ada05
Next: Initialization of Arrays in Ada
From: Hibou57 (Yannick Duchêne) on 24 Feb 2010 03:39

Hello Ada designers,

Do someones or some teams miss Doxygen support for Ada ?
Is there a market or potential fundings for this functionalities ?


--
No-no, this isn't an oops ...or I hope (TM) - Don't blame me... I'm just
not lucky
From: Georg Bauhaus on 24 Feb 2010 05:10
Hibou57 (Yannick Duch�ne) schrieb:
>
> Hello Ada designers,
>
> Do someones or some teams miss Doxygen support for Ada ?
> Is there a market or potential fundings for this functionalities ?

Not being a designer, I still think there already
is something serving as an even better solution
(in terms of real-world usability).

Using facilities of AI05-0183,


procedure Pop (Cap : Bottle_of_Beer)
with Brief => "produces the sound of opening a bottle",
Pre'Class => not Is_Open (Bottle);
From: Hibou57 (Yannick Duchêne) on 24 Feb 2010 06:20
Le Wed, 24 Feb 2010 11:10:16 +0100, Georg Bauhaus
<rm.dash-bauhaus(a)futureapps.de> a écrit:
> Not being a designer, I still think there already
> is something serving as an even better solution
> (in terms of real-world usability).
>
> Using facilities of AI05-0183,
>
>
> procedure Pop (Cap : Bottle_of_Beer)
> with Brief => "produces the sound of opening a bottle",
> Pre'Class => not Is_Open (Bottle);
We all wait for that, but it is not there, and anyway, it's source and
source will never have the expected properties of a document (like
publication, browsing).

I was also seeking for something like this for other purpose I will not
talk about for the moment (let say it has to deal with verbosity and
contexts which are foreign to sources).

Jean-Pierre has pointed a worth to see solution by the way (on the french
c.l.a, where I first mistakenly sent the same question) : he pointed about
NaturalDocs, which seems promising : http://www.naturaldocs.org/
Supports numerous languages : this is helpful when integration of
different solutions is to be handled.

--
No-no, this isn't an oops ...or I hope (TM) - Don't blame me... I'm just
not lucky
From: Georg Bauhaus on 24 Feb 2010 08:05
Hibou57 (Yannick Duch�ne) schrieb:
> Le Wed, 24 Feb 2010 11:10:16 +0100, Georg Bauhaus
> <rm.dash-bauhaus(a)futureapps.de> a �crit:
>> Not being a designer, I still think there already
>> is something serving as an even better solution
>> (in terms of real-world usability).
>>
>> Using facilities of AI05-0183,
>>
>>
>> procedure Pop (Cap : Bottle_of_Beer)
>> with Brief => "produces the sound of opening a bottle",
>> Pre'Class => not Is_Open (Bottle);
> We all wait for that, but it is not there, and anyway, it's source and
> source will never have the expected properties of a document (like
> publication, browsing).

Two remarks.

1) Ada "aspects" and solutions similar to NaturalDocs (which looks
a bit like a mix of Java comments and Python comments) need not
be mutually exclusive. With aspects, however, the Ada grammer
will guide the compiler, the comipler will mark errors,
and, importantly, do so without too much comment syntax awareness :
If there is an identifier in a "comment aspect" and this identifier
is not visible where the subprogram is declared (of which the comment
is an aspect), then the compiler proper will diagnose this error.


| procedure Pop (Cap : Bottle_of_Beer)
| with Brief => "produces the sound of opening `Bottle`",
| Pre'Class => not Is_Open (Bottle);

$ future.ada.compiler example.ada
(C) The Hot Air Dptmt. 20XX

example.ada:14:60: Identifier "Bottle" is not known here
example.ada:15:45: Identifier "Bottle" is not known here

Therefore I think there is a way to, finally, force
us programmers to keep comments and code in sync
and have the compiler tell us if we don't!

2) The first example of NaturalDocs is telling, I'd say.
Effectively, is shows two syntaxes for declaring subprograms:
- one that is explaining what is going on, what the parameters
are etc. and
- the other, which needs the first syntax in addition because
it features the typical {}-languages' obfuscating syntax
for declaring things...

Can we do better?
From: Stephen Leake on 25 Feb 2010 07:12
"Hibou57 (Yannick Duchêne)" <yannick_duchene(a)yahoo.fr> writes:

> Do someones or some teams miss Doxygen support for Ada ?
> Is there a market or potential fundings for this functionalities ?

I have never been happy with the documentation produced by Doxygen for
C++ projects. I'd much rather have the actual source code, in an
editor/viewer that supports full navigation (like GPS or Emacs Ada
mode for Ada).

Once you separate the comments from the actual code, the quality
degrades.

--
-- Stephe
 |  Next  |  Last
Pages: 1 2 3 4 5 6
Prev: Conversion from Ada95 to Ada05
Next: Initialization of Arrays in Ada