Documentation Generation for Maxima Files



If you mean source code documentation generated from the lisp files, we
don't :-(.  The closest anyone has come to that is this:

http://maxima.sourceforge.net/maximaalbert

using http://albert.sf.net, which is promising but needs to break up
the listings of the MAXIMA package into smaller html files than 10
megs. Also, it needs to be taught more about the macros used in Maxima
- current listings are incomplete because only defmfun and defmvar are
handled.

Part of the problem is just that Maxima's source code is largely
undocumented, so the documentation that gets generated has little to no
docstring based explanation.  IMO this needs to change, but the task is
monumental and in many cases it would be easier (and cleaner) to
rewrite old code than figure it out.

If you want autogenerated source docs, my advice is to add a feature to
albert to allow it to create more reasonable html pages for big
packages, and go from there.

Cheers,
CY

--- "Christiansson, G.A.V." 
wrote:

> Good day,
> 
> Is there a doxygen (or equivalent) filter for documentation
> generation for Maxima source files?
> 
> How do you produce documentation for your packages?
> What is considered to be best-practice?
> 
> Best regards,
> 
> 			Göran Christiansson
> 
> _______________________________________________
> Maxima mailing list
> Maxima@www.math.utexas.edu
> http://www.math.utexas.edu/mailman/listinfo/maxima
> 


__________________________________________________
Do You Yahoo!?
Tired of spam?  Yahoo! Mail has the best spam protection around 
http://mail.yahoo.com