octave-maintainers
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Documenting Octave Source


From: JD Cole
Subject: Documenting Octave Source
Date: Thu, 26 Feb 2004 19:25:33 -0800
User-agent: Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.5) Gecko/20031007

Would anyone be opposed to adding more thorough documentation to the Octave source code. I know when I go through the sources to try to implement something new, there's a lot of "discovery" going on, as with any large body of code. I often make comments for myself, but I would happily donate such comments to the project if they are correct. This would, of course, be somewhat of a piecemail process, I wouldn't expect anyone to go through each source file and comment on each function, but I'm sure the results would accumulate over time. As you have probably read, I have suggested that new Octave hackers use doxygen to get a better grip on class dependencies, etc. Adding comments in a format accepted by doxygen would definitely expedite the learning process, not to mention benefit bug fixing and implementation.

Any thoughts?

JD



reply via email to

[Prev in Thread] Current Thread [Next in Thread]