[plt-scheme] doc.txt syntax

From: Robby Findler (robby at cs.uchicago.edu)
Date: Fri Oct 29 09:52:04 EDT 2004

At Fri, 29 Oct 2004 08:47:23 -0700, Matthew Flatt wrote:
>   For list-related administrative tasks:
>   http://list.cs.brown.edu/mailman/listinfo/plt-scheme
> 
> At Thu, 28 Oct 2004 16:07:53 -0400, Doug Orleans wrote:
> > I've noticed that library documentation in doc.txt files obeys a
> > particular syntax.  [...] Is the syntax for this annotation language
> > documented anywhere?
> 
> Yes. Search for "doc.txt" in Help Desk, or see "doc.txt" in the "help"
> collection.
> 
> > Are there tools to generate doc.txt files from source
> > code comments?
> 
> Not currently.

Probably if you were generating something from source code, however,
you'd want to generate .html files and hdindex / keywords files.
doc.txt is meant to be WYSIWYG format for quick docs writing.

Robby


Posted on the users mailing list.