docs: Update documentation and Doxygen documentation generation
diff --git a/utils/tracers/ipv4-app-tracer.h b/utils/tracers/ipv4-app-tracer.h
index 0322d96..d574117 100644
--- a/utils/tracers/ipv4-app-tracer.h
+++ b/utils/tracers/ipv4-app-tracer.h
@@ -29,6 +29,10 @@
class Ipv4Header;
+/**
+ * @ingroup ndn-tracers
+ * @brief Base class for IPv4/TCP based applications
+ */
class Ipv4AppTracer : public SimpleRefCount<Ipv4AppTracer>
{
public:
diff --git a/utils/tracers/ipv4-l3-tracer.h b/utils/tracers/ipv4-l3-tracer.h
index 2e08054..b63dc01 100644
--- a/utils/tracers/ipv4-l3-tracer.h
+++ b/utils/tracers/ipv4-l3-tracer.h
@@ -29,6 +29,10 @@
class Node;
+/**
+ * @ingroup ndn-tracers
+ * @brief Base class for IPv4 network-layer tracers
+ */
class Ipv4L3Tracer : public SimpleRefCount<Ipv4L3Tracer>
{
public:
diff --git a/utils/tracers/ipv4-rate-l3-tracer.h b/utils/tracers/ipv4-rate-l3-tracer.h
index d4be0a9..b039822 100644
--- a/utils/tracers/ipv4-rate-l3-tracer.h
+++ b/utils/tracers/ipv4-rate-l3-tracer.h
@@ -34,8 +34,8 @@
namespace ns3 {
/**
- * @ingroup ccnx
- * @brief CCNx network-layer rate tracer
+ * @ingroup ndn-tracers
+ * @brief IPv4 network-layer rate tracer
*/
class Ipv4RateL3Tracer : public Ipv4L3Tracer
{
diff --git a/utils/tracers/ipv4-seqs-app-tracer.h b/utils/tracers/ipv4-seqs-app-tracer.h
index 5baa9f5..5a64a5a 100644
--- a/utils/tracers/ipv4-seqs-app-tracer.h
+++ b/utils/tracers/ipv4-seqs-app-tracer.h
@@ -27,6 +27,10 @@
namespace ns3 {
+/**
+ * @ingroup ndn-tracers
+ * @brief Helper to track application-level sequence numbers (approximated from TCP ACKs)
+ */
class Ipv4SeqsAppTracer : public Ipv4AppTracer
{
public:
diff --git a/utils/tracers/l2-rate-tracer.h b/utils/tracers/l2-rate-tracer.h
index 48105ac..de6ffcb 100644
--- a/utils/tracers/l2-rate-tracer.h
+++ b/utils/tracers/l2-rate-tracer.h
@@ -33,7 +33,10 @@
namespace ns3 {
/**
- * @ingroup ndn
+ * @ingroup ndn-tracers
+ * @brief Tracer to collect link-layer rate information about links
+ *
+ * @todo Finish implementation
*/
class L2RateTracer : public L2Tracer
{
diff --git a/utils/tracers/l2-tracer.h b/utils/tracers/l2-tracer.h
index a937d66..e6378b5 100644
--- a/utils/tracers/l2-tracer.h
+++ b/utils/tracers/l2-tracer.h
@@ -29,6 +29,12 @@
class Node;
+/**
+ * @ingroup ndn-tracers
+ * @brief Link-layer tracer
+ *
+ * @todo Finish implementation
+ */
class L2Tracer : public SimpleRefCount<L2Tracer>
{
public:
diff --git a/utils/tracers/ndn-app-delay-tracer.h b/utils/tracers/ndn-app-delay-tracer.h
index 7312225..dfbe5ea 100644
--- a/utils/tracers/ndn-app-delay-tracer.h
+++ b/utils/tracers/ndn-app-delay-tracer.h
@@ -41,8 +41,8 @@
class App;
/**
- * @ingroup ndn
- * @brief network-layer tracer for aggregate packet counts
+ * @ingroup ndn-tracers
+ * @brief Tracer to obtain application-level delays
*/
class AppDelayTracer : public SimpleRefCount<AppDelayTracer>
{
diff --git a/utils/tracers/ndn-cs-tracer.h b/utils/tracers/ndn-cs-tracer.h
index 87c290e..906e85a 100644
--- a/utils/tracers/ndn-cs-tracer.h
+++ b/utils/tracers/ndn-cs-tracer.h
@@ -48,6 +48,7 @@
namespace cs {
+/// @cond include_hidden
struct Stats
{
inline void Reset ()
@@ -58,11 +59,12 @@
double m_cacheHits;
double m_cacheMisses;
};
+/// @endcond
}
/**
- * @ingroup ndn
+ * @ingroup ndn-tracers
* @brief NDN tracer for cache performance (hits and misses)
*/
class CsTracer : public SimpleRefCount<CsTracer>
diff --git a/utils/tracers/ndn-l3-aggregate-tracer.h b/utils/tracers/ndn-l3-aggregate-tracer.h
index 98e6731..fdbf23c 100644
--- a/utils/tracers/ndn-l3-aggregate-tracer.h
+++ b/utils/tracers/ndn-l3-aggregate-tracer.h
@@ -36,8 +36,8 @@
namespace ndn {
/**
- * @ingroup ndn
- * @brief CCNx network-layer tracer for aggregate packet counts
+ * @ingroup ndn-tracers
+ * @brief NDN network-layer tracer for aggregate packet counts
*/
class L3AggregateTracer : public L3Tracer
{
diff --git a/utils/tracers/ndn-l3-rate-tracer.h b/utils/tracers/ndn-l3-rate-tracer.h
index 60bb616..9df79b1 100644
--- a/utils/tracers/ndn-l3-rate-tracer.h
+++ b/utils/tracers/ndn-l3-rate-tracer.h
@@ -36,8 +36,8 @@
namespace ndn {
/**
- * @ingroup ndn
- * @brief CCNx network-layer rate tracer
+ * @ingroup ndn-tracers
+ * @brief NDN network-layer rate tracer
*/
class L3RateTracer : public L3Tracer
{
diff --git a/utils/tracers/ndn-l3-tracer.h b/utils/tracers/ndn-l3-tracer.h
index 260fe61..ee525ed 100644
--- a/utils/tracers/ndn-l3-tracer.h
+++ b/utils/tracers/ndn-l3-tracer.h
@@ -24,6 +24,11 @@
#include "ns3/ptr.h"
#include "ns3/simple-ref-count.h"
+/**
+ * @ingroup ndn-helpers
+ * @defgroup ndn-tracers Helpers to simplify metric collection
+ */
+
namespace ns3 {
class Node;
@@ -41,6 +46,7 @@
class ContentObject;
/**
+ * @ingroup ndn-tracers
* @brief Base class for network-layer (incoming/outgoing Interests and Data) tracing of NDN stack
*/
class L3Tracer : public SimpleRefCount<L3Tracer>