[Ns-bugs] [Bug 126] New: [patch] some adjustments to doxygen layout

bugzilla-daemon@nsnam-www.ece.gatech.edu bugzilla-daemon at nsnam-www.ece.gatech.edu
Thu Jan 10 07:37:47 PST 2008


http://www.nsnam.org/bugzilla/show_bug.cgi?id=126

           Summary: [patch] some adjustments to doxygen layout
           Product: ns-3
           Version: unspecified
          Platform: All
        OS/Version: All
            Status: NEW
          Keywords: patch
          Severity: normal
          Priority: P3
         Component: documentation
        AssignedTo: ns-bugs at isi.edu
        ReportedBy: tomh at tomh.org


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?


-- 
Configure bugmail: http://www.nsnam.org/bugzilla/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are the assignee for the bug, or are watching the assignee.


More information about the Ns-bugs mailing list