danielk at cat
May 13, 2005, 8:13 PM
Post #5 of 5
(854 views)
Permalink
|
On Fri, 2005-05-13 at 16:00 -0600, Devan Lippman wrote:
> I've been reading through a lot of the job queue stuff lately, what
> would be a good way of documenting this that works for you?
The best way would be to write doxygen documentation.
You can create group (module) documentation, for a
collection of classes say. This might be a good place to
describe a concept such as the job queue, but it might
also work as class documentation if there is one class
that orchestrates the whole process.
But if doxygen looks like too much to learn, or you
just have problems creating a plan of attack for the
job queue in particular, I could take a plain text file
describing the job queue and doxygenify it.
-- Daniel
|
