[Ns-developers] documentation: manual vs doxygen
Nicola Baldo
nbaldo at cttc.es
Mon Mar 14 03:00:26 PDT 2011
Hi all,
currently the documentation (design documentation, user-visible
features, etc) for several modules is provided both in the manual and
through doxygen. Examples:
wifi
http://www.nsnam.org/docs/manual/html/wifi.html
http://www.nsnam.org/doxygen/group___wifi.html
wimax
http://www.nsnam.org/docs/manual/html/wimax.html
http://www.nsnam.org/doxygen/group___wi_m_a_x.html
Having very similar information in two places is harder to maintain, and
also makes it more difficult for the user to find where the information is.
Can we decide on a single location where we should put the
documentation? I propose to have it in the manual, leaving doxygen for
the API only.
The only issue that I see is how to integrate this in the modular build:
ideally, developers should be able to provide manual sources within the
module directory.
Nicola
More information about the Ns-developers
mailing list