comp.lang.ada
 help / color / mirror / Atom feed
From: "Robert C. Leif" <rleif@rleif.com>
Subject: RE: Building documentation from comments
Date: Thu, 7 Nov 2002 15:54:09 -0800
Date: 2002-11-07T15:54:09-08:00	[thread overview]
Message-ID: <mailman.1036713302.12667.comp.lang.ada@ada.eu.org> (raw)
In-Reply-To: <x7vr8dx14iu.fsf@smaug.pushface.org>

Returning to the title of this thread, "Building documentation from
comments", one might wish to replace the comment with the equivalent of
an XML Annotation or Annotations.Documentation. The Ada translation of
the XML model would be to create an Annotations Package and a
Documentation child package.  These packages would included an
instantiation of a bounded string type of the appropriate size to be a
Copyright(Copyright_Bd). Each package then can have a group of
annotations that include the Copyright_Bd, Author(s) Revision_Dates etc.
These can even have default values or when appropriate point to a URL.
The use of a URL has the advantage of permitting direct access to the
text of large legal documents without cluttering the code.
Bob Leif





  reply	other threads:[~2002-11-07 23:54 UTC|newest]

Thread overview: 20+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2002-11-05 16:41 Building documentation from comments Victor Porton
2002-11-06  1:30 ` Ira Baxter
2002-11-06  2:56 ` Caffeine Junky
2002-11-06  7:37 ` Victor Porton
2002-11-06 11:35   ` Larry Kilgallen
2002-11-06 15:11     ` Ira Baxter
2002-11-06  8:30 ` Victor Porton
2002-11-06  9:39   ` David C. Hoos
2002-11-06 12:24   ` Marc A. Criley
2002-11-06 15:17   ` Ira Baxter
2002-11-07 20:55   ` Simon Wright
2002-11-06 11:36 ` Victor Porton
2002-11-06 15:24   ` Ted Dennison
2002-11-07 20:58   ` Simon Wright
2002-11-07 23:54     ` Robert C. Leif [this message]
2002-11-07  4:16 ` Victor Porton
2002-11-07 15:48   ` Stephen Leake
2002-11-08  4:10 ` Victor Porton
2002-11-08  4:14 ` Victor Porton
2002-11-10 18:39   ` Michael Erdmann
replies disabled

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