The ns-3 Network Simulator Project

Put all doxy in the right module

We use Doxygen for creating documentation of the source files and API. With a large code base like ns-3 this becomes unwieldy without some organization. We have chosen to organize the documentation along the modules used to organize the code.

Read the Manual section on Documenting with Doxygen to see how we recommend creating and using Doxygen groups to mirror the source code modules.

Your task is the following:

  1. Select a single module in src.
  2. Find the \defgroup for this module. You're going to need the Doxygen name for the group.
  3. For each file, and each item at file scope, such as a class, free function, enum, etc. check that it's Doxygen comment includes the correct \ingroup comment.
  4. Create a patch for the module which adds the missing comments.

Task tags

  • doxygen

Students who completed this task

hax0kartik

Task type

  • chrome_reader_mode Documentation / Training
close

2019