comp.lang.ada
 help / color / mirror / Atom feed
From: Thomas Wolf <t_wolf@angelfire.com>
Subject: AdaBrowse 1.5 available
Date: Thu, 4 Apr 2002 10:33:11 +0200
Date: 2002-04-04T10:33:11+02:00	[thread overview]
Message-ID: <MPG.17162e33c80a52ca989687@news.ip-plus.net> (raw)


AdaBrowse is a HTML documentation generator for Ada 95 library
unit specs, similar to what javadoc does for Java.

AdaBrowse is GPLed and available at the URL

<http://home.tiscalinet.ch/t_wolf/tw/ada95/adabrowse/>,
 
both a pre-built executable (for Win NT/2k and GNAT 3.14p), and the
sources.

An example of what AdaBrowse can do is at the URL
<http://home.tiscalinet.ch/t_wolf/tw/ada95/util/doc/>.

AdaBrowse is a command-line utility; it has no graphical user
interface. It is highly configurable through command line options,
style sheets, and configuration files.

AdaBrowse takes apart the Ada 95 source and produces a structured
and extensively cross-referenced HTML documentation from it. It
extracts Ada comments and generates formatted descriptions from them.
For packages, it also produces a (cross-linked) type index containing
links to the primitive operations of the types.

AdaBrowse uses ASIS to gather semantic information about a library
unit spec. It can handle whole libraries and produce global unit,
subprogram, and type indices for all library units.

AdaBrowse has been extensively tested on many publicly available
Ada 95 libraries and specially constructed test cases (in total
more than 1000 Ada 95 library unit specs).

V1.5 has been improved in many ways over the last announced V1.2,
including:

- some bug fixes, and more work-arounds for bugs in ASIS-for-GNAT.
- support for krunched file names.
- index generation for units, subprograms, and types.

AdaBrowse builds and runs without further ado on both Win NT/2k
and Unix systems, and shouldn't be too hard to port to other ASIS
implementations than ASIS-for-GNAT.

The distribution comes with a comprehensive user's guide including
examples and instructions on how and where to submit bug reports.

AdaBrowse differs from gnathtml in several ways:

- AdaBrowse is a stand-alone executable; gnathtml is a perl script.
- AdaBrowse is more flexible, and can be customized to a much
  greater extent.
- AdaBrowse produces structured HTML output including formatted
  descriptions; gnathtml basically just encloses the source in
  <PRE></PRE> tags and adds cross-references.
- AdaBrowse uses ASIS to collect cross-reference information,
  whereas gnathtml relies on the GNAT-specific cross-reference
  info in the ALI files.
- AdaBrowse uses ASIS to gather semantic information about library
  units and makes use of it, e.g. to find all the primitive operations
  of a type.
- AdaBrowse can call e.g. a compiler if no ASIS information is found,
  whereas gnathtml doesn't generate cross-references if no ALI file
  is found.
- AdaBrowse does some limited form of pretty-printing, such as using
  identifiers as cased in their definition everywhere.

-- 
-----------------------------------------------------------------
Thomas Wolf                          e-mail: t_wolf@angelfire.com




             reply	other threads:[~2002-04-04  8:33 UTC|newest]

Thread overview: 14+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2002-04-04  8:33 Thomas Wolf [this message]
2002-04-04 17:03 ` AdaBrowse 1.5 available Ted Dennison
2002-04-04 18:21   ` tmoran
2002-04-05  0:28     ` Jeffrey Creem
2002-04-07 11:30     ` Florian Weimer
2002-04-07 21:38       ` tmoran
2002-04-05  7:50   ` Thomas Wolf
2002-04-05 16:17     ` Ted Dennison
2002-04-07 20:40       ` Thomas Wolf
2002-04-08 14:25         ` Ted Dennison
2002-04-07 11:42     ` Florian Weimer
2002-04-07 13:26       ` Pascal Obry
2002-04-07 16:36         ` Florian Weimer
2002-04-07 23:13           ` jim
replies disabled

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