[Ns-developers] some ns-3 documentation proposals

[craigdo@ee.washington.edu]

> I think that it would be probably much easier to 
> just move everything to doxygen, including the 
> tutorial.

I'm in the process of converting the remaining tutorial pieces to .texi and
adding a bunch more content *now*, so I would hate to see another change of
direction while I'm still in the middle of changing from the old direction.
;-)

In the long run, I'd be fine moving everything to Doxygen if it can do what
we want.  Having a single model for documentation appeals to my internal
need for logic, consistency, and a simple book of instructions.  I'll be
perfectly happy to go with whatever markup language we want -- I have no
religious constraints.  However, as someone I know has said in the past,
"let's just make a decision and stick with it."  :-/

-- Craig

> -----Original Message-----
> From: ns-developers-bounces at ISI.EDU 
> [mailto:ns-developers-bounces at ISI.EDU] On Behalf Of Mathieu Lacage
> Sent: Wednesday, December 12, 2007 11:02 PM
> To: Tom Henderson
> Cc: ns-developers
> Subject: Re: [Ns-developers] some ns-3 documentation proposals
> 
> On Wed, 2007-12-12 at 21:21 -0800, Tom Henderson wrote:
> > The current proposal is to do the following:
> > 1) move the tutorial from docs/tutorial to 
> ns-3-dev/doc/tutorial directory
> > 2) complete the cutover from latex to texinfo format for 
> the tutorial
> > 3) develop the Doxygen documentation further so that it can 
> serve also 
> > as the ns-3 manual, and abandon the docs/manual separate manual
> > 
> > Is there any objection to doing 1 and 2 (if 2 can be 
> completed) for this 
> > release, and 3) for next release, or other suggestions?
> 
> I think that it would be probably much easier to just move 
> everything to
> doxygen, including the tutorial. I would be willing to do the 
> necessary
> monkey-type work for the conversion.
> 
> regards,
> Mathieu
>