comp.lang.ada
 help / color / mirror / Atom feed
From: tmoran@acm.org
Subject: Re: Q: Generating Documenation from Ada Sources?
Date: Mon, 13 May 2002 22:25:18 GMT
Date: 2002-05-13T22:25:18+00:00	[thread overview]
Message-ID: <i3XD8.875$ko7.73823340@newssvr14.news.prodigy.com> (raw)
In-Reply-To: 3CE02030.7040500@snafu.de

> > conventions in coding style, so AdaBrowse+ can know which comments are
> > "relevant".
>...
> currently playing around with certain heutistics based on a
> minimal common sense snytax, e.g.

  We went a different way, since most of the source files already
existed, including customer's copies, and we didn't want to change
them.  We have a database of information, for instance every entity
has a Remarks section (which of course may be empty) and a Spec
section.  Subprograms additionally have an Exceptions Raised section,
and so forth.  These are filled in as much as possible by a program
that scans source files for specs, links, comments saying "Raises ..."
directly following a subprogram etc.  But this is viewed as just a
convenience.  We expect most of the text to be entered, or at least
modified by, a human writer.  Syntactic information like the file
something is declared in, the package to "with" for it, any
predefined constants of a type, etc comes from scanning the source
code and is not modified by the documentation writer.



  reply	other threads:[~2002-05-13 22:25 UTC|newest]

Thread overview: 16+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2002-05-11 14:59 Q: Generating Documenation from Ada Sources? Michael Erdmann
2002-05-11 18:29 ` Robert Dewar
2002-05-11 19:07   ` Michael Erdmann
2002-05-12  2:05     ` Randy Brukardt
2002-05-12  7:35       ` Michael Erdmann
2002-05-12  8:12         ` Dr. Michael Paus
2002-05-12 15:23           ` Michael Erdmann
2002-05-12 17:49             ` tmoran
2002-05-12 20:43               ` Ira D. Baxter
2002-05-13 14:11             ` Stephen Leake
2002-05-13 20:21               ` Michael Erdmann
2002-05-13 22:25                 ` tmoran [this message]
2002-05-14 18:01                   ` Michael Erdmann
2002-05-13  5:36 ` Stefan Revets
2002-05-13 13:03   ` Georg Bauhaus
2002-05-14  5:20     ` Stefan Revets
replies disabled

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