comp.lang.ada
 help / color / mirror / Atom feed
From: Niklas Holsti <niklas.holsti@tidorum.invalid>
Subject: Re: autogenerate html documentation out of .ads file
Date: Tue, 12 Nov 2019 22:18:30 +0200
Date: 2019-11-12T22:18:30+02:00	[thread overview]
Message-ID: <h30icmFrmvU1@mid.individual.net> (raw)
In-Reply-To: <rrDyF.550373$7ei.349525@fx36.am4>

On 2019-11-12 21:09, Per Sandberg wrote:
> "gnatdoc" (normally part of the gnat-installation) will do the trick.
> /P

There is also (or used to be) a tool called "gnathtml.pl", which is a 
Perl script that generates HTML that looks rather like the Ada source, 
but has cross-links.

I haven't used "gnatdoc" much, but IIRC its output is more like Doxygen 
output, which I don't like. YMMV.

> On 2019-11-12 18:07, Alain De Vos wrote:
>> The file mylibrary.ads contains a list of functions which the outside 
>> world can call.
>> Can I autogenerate a .html file out of this mylibrarya.ads file in 
>> order the let the outside world know this library is available ?

IMO a well-commented .ads file is good enough for that part of the 
outside world that consists of programmers who want to use the package 
(it may not be enough for code reviewers and cross-readers). No 
automatic HTML generator can add the rationales, descriptions, and 
discussions, which IMO are the essential info for using a package 
_correctly_.

--
Niklas Holsti
niklas holsti tidorum fi
       .      @       .


  reply	other threads:[~2019-11-12 20:18 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-11-12 17:07 autogenerate html documentation out of .ads file Alain De Vos
2019-11-12 19:09 ` Per Sandberg
2019-11-12 20:18   ` Niklas Holsti [this message]
2019-11-12 22:57     ` Alain De Vos
2019-11-12 20:07 ` Alain De Vos
2019-11-13 17:15   ` Stephen Leake
2019-11-12 23:04 ` Alain De Vos
replies disabled

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