Home »
Public Forums »
archive »
Documentation time
| Documentation time [message #64533] |
Tue, 06 January 2009 18:20  |
Robbie
Messages: 165
Registered: February 2006
|
Senior Member |
|
|
I'm in the process of documenting a fairly large IDL code base (47K
lines of code in 272 files).
The code base might seem excessive, but I assure you it is nowhere
near as large as iTools (152K in 508 files).
I've started migrating to IDLdoc 3.0 and the rst style of
documentation. I'm using the IDL workbench and the code is managed
using CVS. I have only documented a small portion of the existing code
using IDLdoc 2.0
Is there a way to automatically migrate from the old IDLdoc 2.0 format
to the new rst format?
Does it make sense to CVS commit the documentation, or should I add it
to .cvsignore or just keep it out of the IDL_PATH to be sure?
What value should I put on API documentation? I think that I shouldn't
spend more than 50% of my time on API documentation as opposed to
other more helpful methods of documentation.
Around 30-50% of my code is redundant code (i.e. deprecated). Should I
remove them completely from the CVS tree? Wouldn't it just be
confusing to keep it in the source tree?
I'm keen to take a snapshot now and start to manage the non-deprecated
code as a completely new project.
Thanks
Robbie
|
|
|
|
Current Time: Sat Oct 11 03:21:41 PDT 2025
Total time taken to generate the page: 1.12139 seconds
comp.lang.idl-pvwave archive
Members
Search
Help
Login
Home
