Commenting Seth's Source Code
the purpose is to document Dink's Source Code. In order to achieve that goal, I'll be using a literate programming environment (noWeb-based). All documents produced will be released in tex, pdf, html and ps.
It is a huge project, began by inserting on the documentation file all the code from the Dink Source Project.
Now I'm trying to divide all the functions in a literary programming style (which I believe I'm not that good at
).
Current status (beginning second day of work):
Source Document: 18575 lines, 43444 words, 400842 characters
Resulting Documentation: 348 pages, 61 functions separated, and cross-referenced.
If you want to know more details, comment on this, or e-mail me to BrainMan@iol.pt
It is a huge project, began by inserting on the documentation file all the code from the Dink Source Project.
Now I'm trying to divide all the functions in a literary programming style (which I believe I'm not that good at
).Current status (beginning second day of work):
Source Document: 18575 lines, 43444 words, 400842 characters
Resulting Documentation: 348 pages, 61 functions separated, and cross-referenced.
If you want to know more details, comment on this, or e-mail me to BrainMan@iol.pt
Are you doing this yourself, or are you using a program document outputter, such as dOxygen?
Doing it on myself... now I do have three main files, separated all functions into different code chunks. Hope to have at least one of the files commented until the end of the week.
Going to see what kind of help dOxygen gives me, thanks for the tip
Going to see what kind of help dOxygen gives me, thanks for the tip
