From mboxrd@z Thu Jan  1 00:00:00 1970
X-Spam-Checker-Version: SpamAssassin 3.4.4 (2020-01-24) on polar.synack.me
X-Spam-Level: 
X-Spam-Status: No, score=-1.9 required=5.0 tests=BAYES_00
	autolearn=unavailable autolearn_force=no version=3.4.4
Path: 
 eternal-september.org!reader01.eternal-september.org!feeder.eternal-september.org!news.swapon.de!fu-berlin.de!uni-berlin.de!individual.net!not-for-mail
From: Niklas Holsti <niklas.holsti@tidorum.invalid>
Newsgroups: comp.lang.ada
Subject: Re: autogenerate html documentation out of .ads file
Date: Tue, 12 Nov 2019 22:18:30 +0200
Organization: Tidorum Ltd
Message-ID: <h30icmFrmvU1@mid.individual.net>
References: <125d4991-6a02-4f2b-bb97-8d055826bc2c@googlegroups.com>
 <rrDyF.550373$7ei.349525@fx36.am4>
Mime-Version: 1.0
Content-Type: text/plain; charset=utf-8; format=flowed
Content-Transfer-Encoding: 7bit
X-Trace: individual.net xlq7xyX/iIyEKhMnIN9LFgYvApOeR6kFKbXeh9WnFWCx95yqLc
Cancel-Lock: sha1:QpMJyUV8ltZVPR8xtiUvVZtE0bA=
User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10.14; rv:68.0)
 Gecko/20100101 Thunderbird/68.2.0
In-Reply-To: <rrDyF.550373$7ei.349525@fx36.am4>
Content-Language: en-US
Xref: reader01.eternal-september.org comp.lang.ada:57562
Date: 2019-11-12T22:18:30+02:00
List-Id: <comp.lang.ada>

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
       .      @       .