Hello everyone,

Does anyone have a solution (a la Java) whereby a program or script
reads a lisp source code file and produces programmer documentation?
The format of the doc could be html or rtf....

Perhaps something like this:


<module-name at ;;;;> Infrastructure
<module-description at ;;;;> This is the infrastructure module, it provides ....

;;; @function foo
;;; @author john doe
(defun foo (arg-1)
 "foo takes an argument and returns it back to you"
 <special-code at ;;> Notice we don't check the argument type
  arg-1)

;;; @macro bar
;;; @author bill jones
(defmacro bar ()
 "bar takes nothing and does nothing with it."
 )


Which could produce something like this:


1.  Infrastructure

1.1  Description

This is the infrastructure module, it provides ....


1.2  API              ( <-- inferred! )

1.2.1  Foo  [function]

	Args:  arg-1
	Doc string: foo takes and argument and returns it back to you
	Code notes: Notice we don't check the argument type


1.2.2  Bar   [macro]

	Args: 
	Doc string: bar takes nothing and does nothing with it.
	Code notes:



thanx,
+Rick

--
Rick "Carm" Chimera             | office:  305 S. Craig Street, Suite 100
Wisdom Technologies Corporation |  voice:  1.412.688.8781 x240
414 S. Craig Street, Suite 304  |    fax:  1.412.268.6298
Pittsburgh, PA 15213    USA     |  email:  <wisdomtechnologies.com at carm>
"Any and all statements, representations, etc. made above are mine and
 do not necessarily represent those of my employer, my computer/internet
 service provider, my mother, nor anyone else except as noted."
This message (c)Copyright 1997, Rick Chimera.  All rights reserved.  Really.