utils: Use @ Doxygen tags in code generated by create-module.py

This commit is contained in:
Eduardo Almeida
2024-11-22 15:29:22 +00:00
parent 123b04a8e3
commit 4e310a0d96

View File

@@ -51,14 +51,14 @@ MODEL_H_TEMPLATE = """\
// Add a doxygen group for this module.
// If you have more than one file, this should be in only one of them.
/**
* \defgroup {MODULE} Description of the {MODULE}
* @defgroup {MODULE} Description of the {MODULE}
*/
namespace ns3
{{
// Each class should be documented using Doxygen,
// and have an \ingroup {MODULE} directive
// and have an @ingroup {MODULE} directive
/* ... */
@@ -90,7 +90,7 @@ namespace ns3
{{
// Each class should be documented using Doxygen,
// and have an \ingroup {MODULE} directive
// and have an @ingroup {MODULE} directive
/* ... */
@@ -113,7 +113,7 @@ EXAMPLE_CC_TEMPLATE = """\
#include "ns3/{MODULE}-helper.h"
/**
* \\file
* @file
*
* Explain here what the example does.
*/
@@ -154,14 +154,14 @@ using namespace ns3;
// Add a doxygen group for tests.
// If you have more than one test, this should be in only one of them.
/**
* \defgroup {MODULE}-tests Tests for {MODULE}
* \ingroup {MODULE}
* \ingroup tests
* @defgroup {MODULE}-tests Tests for {MODULE}
* @ingroup {MODULE}
* @ingroup tests
*/
// This is an example TestCase.
/**
* \ingroup {MODULE}-tests
* @ingroup {MODULE}-tests
* Test case for feature 1
*/
class {CAPITALIZED}TestCase1 : public TestCase
@@ -204,7 +204,7 @@ void
// this class must be defined
/**
* \ingroup {MODULE}-tests
* @ingroup {MODULE}-tests
* TestSuite for module {MODULE}
*/
class {CAPITALIZED}TestSuite : public TestSuite
@@ -222,7 +222,7 @@ class {CAPITALIZED}TestSuite : public TestSuite
// Do not forget to allocate an instance of this TestSuite
/**
* \ingroup {MODULE}-tests
* @ingroup {MODULE}-tests
* Static variable for test initialization
*/
static {CAPITALIZED}TestSuite s{COMPOUND}TestSuite;