>>>>> "CY" == C Y <smustudent1@yahoo.com> writes:
CY> Does anyone know of any method out there to parse comments in some form
CY> from lisp code to form texi files? If not, would it be worthwhile to
There is a package, userman, in the CMU AI Archives that took
docstrings (I think) and converted them to LaTeX format for inclusion
in a user's manual. It included the function name and arguments with
too. It worked ok, but you had to write the docstrings in with LaTeX
commands if you wanted anything other than simple formatting.
CY> Also, the other significant problem is the interdependancy of the files
CY> and functions in the system - it would be very helpful to document
CY> these. I was wondering if it would be possible to generate a map of
CY> all the functions in the Maxima system and which functions they depend
CY> on. This does not entirely solve the problem, but in theory at least
CY> it should help - if we edit some part of the code we can look and see
CY> what other parts of the system depend on that code, and what the impact
CY> might be. Does anybody know of such a source code mapper? A graphical
CY> map would be neat, but the really useful part would be to be able to
CY> add to the documentation a record of the interdepenancies of the code.
CY> Does anyone know of such a tool?
FWIW, someone has just implemented such a xref tool for CMUCL. It's
built into the compiler so it's always right, unlike the xref tool in
the CMU AI Archives.
Ray