Bug 126

Summary:	[patch] some adjustments to doxygen layout
Product:	ns-3	Reporter:	Tom Henderson <tomh>
Component:	documentation	Assignee:	ns-bugs <ns-bugs>
Status:	RESOLVED FIXED
Severity:	normal	Keywords:	patch
Priority:	P3
Version:	pre-release
Hardware:	All
OS:	All
Attachments:	patch for doxygen

Description Tom Henderson 2008-01-10 10:37:47 UTC

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 Tom Henderson 2008-01-10 10:39:58 UTC

Created attachment 102 [details]
patch for doxygen

Comment 2 Tom Henderson 2008-01-10 10:40:34 UTC

sample output for this patch can be viewed at:
http://www.nsnam.org/temp/doxygen-proposal/

Comment 3 Tom Henderson 2008-01-14 00:58:49 UTC

changeset 2217 in ns-3-dev.