Bug 126 - [patch] some adjustments to doxygen layout
: [patch] some adjustments to doxygen layout
Status: RESOLVED FIXED
: ns-3
documentation
: pre-release
: All All
: P3 normal
Assigned To:
:
: patch
:
:
  Show dependency treegraph
 
Reported: 2008-01-10 10:37 EDT by
Modified: 2008-07-01 13:32 EDT (History)


Attachments
patch for doxygen (16.96 KB, patch)
2008-01-10 10:39 EDT, Tom Henderson
Details | Diff


Note

You need to log in before you can comment on or make changes to this bug.


Description From 2008-01-10 10:37:47 EDT
Here is a patch of some reorganization of doxygen.  The main changes:
- a new file doc/modules to organize the doxygen by source code module.  This
also resulted in a lot of small touches to the source to put "\ingroup" tags to
make them subgroups.
- new directory doc/howtos/-- this is intended for lengthier howtos-- it ends
up as a "Related Page"
- tutorial is absent from this patch, however (plan to go back to texinfo)
- change main.txt to main.h-- proposal that we use the ".h" suffix consistently
for doxygen files

An open issue:
- where does doc/tracing.h live?  Should files of this type be moved to the
howtos directory, or to the src/core module itself?
------- Comment #1 From 2008-01-10 10:39:58 EDT -------
Created an attachment (id=102) [details]
patch for doxygen
------- Comment #2 From 2008-01-10 10:40:34 EDT -------
sample output for this patch can be viewed at:
http://www.nsnam.org/temp/doxygen-proposal/
------- Comment #3 From 2008-01-14 00:58:49 EDT -------
changeset 2217 in ns-3-dev.