[Ns-developers] Proposed Simulator Changes
craigdo at ee.washington.edu
Tue Oct 14 16:41:38 PDT 2008
> IMHO, when extensive documentation exists it should have two levels of
> detail. A first level should be concise and clear, and
> include a link for a
> section (or another document) with more extensive
> information. This should
> make everybody happy, I think.
I think this is right. I think there should be a brief (@brief) description
of what the function does and what its parameters and return values are. I
think there should be a more detailed explanation close by. This seems to
be the way most of our doxygen is written.
I think there is a generally missing level of detail (not the tutorial, not
the manual) that we began to address in some of the models, where there is a
separate header file that documents what each model is doing and what it
attempts to model. An example is csma.h.
It might be good to have something like that for each major functional
block. That would give me a place to talk in more detail about how methods
interact and a place to define and discuss some of those tricky bits that
take all the words. If you want to make them manual sections, that's fine;
but I like them to be close to the code (as in the same directory) instead
of off somewhere random.
More information about the Ns-developers