Combining documentation with source code is what Knuth's
literate programming is aimed at. For example, the Axiom
project has adopted this approach (using the noweb tool).
Kostas
On 09/27/10 04:28 AM, Jaime Villate wrote:
> On Sun, 2010-09-26 at 20:45 -0600, Robert Dodier wrote:
>>> I am interested to add the documentations to the project. We might
>> add
>>> it to the Lisp files (the documentation might be to verbose) or we
>> start
>>> to add a technical documentation in a TEXI format.
>>
>> For detailed documentation of internal Lisp functions,
>> I think it's best to paste the documentation into the source code.
>
> I also vote for including the documentation within the source code,
> rather than in a separate Texinfo file.
> It would be very useful if Dieter writes a README file giving us some
> tips on how to document the source files.
>
> Regards,
> Jaime
>
>
> _______________________________________________
> Maxima mailing list
> Maxima at math.utexas.edu
> http://www.math.utexas.edu/mailman/listinfo/maxima