[Ns-developers] some ns-3 documentation proposals

[Mathieu Lacage]

On Thu, 2007-12-13 at 23:57 -0800, craigdo at ee.washington.edu wrote:
> > If you can point me to the texi source you 
> > have, I can verify that dox has the matching tags.
> 
> ns-3-dev/doc/tutorial/tutorial.texi

I think that it should be straightforward to port:
  - commands to describe item lists, paragraphs, sections, chapters,
code exerpts
  - index entries should be supported in the latex output of doxygen
with the \addindex command. They won't be supported in the html output.
 
If you want to control in a fine way the latex output, you can always
include some latex-specific commands with \latexonly or, use a \htmlonly
command.

It is possible to use conditional sections with the \if command which
you seem to be using in the texinfo source.

To summarize, if you use the /*! and */ start and end markers at the
start of your source files, the bulk of the conversion is a matter of
sed scripts. Converting some of the more elaborate conditional
constructs might be a bit more painful but I don't see any big missing
feature beyond the lack of an index in the html output which might be a
big problem if you care very much about it.

regards,
Mathieu