From 063c98f45f188a76227046db53f271acc5cde017 Mon Sep 17 00:00:00 2001 From: Natale Patriciello Date: Wed, 13 Jul 2016 09:48:52 +0200 Subject: [PATCH] traffic-control: inserted defgroup --- src/traffic-control/model/traffic-control-layer.h | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/src/traffic-control/model/traffic-control-layer.h b/src/traffic-control/model/traffic-control-layer.h index 71875557c..0794fd550 100644 --- a/src/traffic-control/model/traffic-control-layer.h +++ b/src/traffic-control/model/traffic-control-layer.h @@ -33,14 +33,19 @@ class Packet; class QueueDiscItem; /** + * \defgroup traffic-control + * + * The Traffic Control layer aims at introducing an equivalent of the Linux Traffic + * Control infrastructure into ns-3. The Traffic Control layer sits in between + * the NetDevices (L2) and any network protocol (e.g., IP). It is in charge of + * processing packets and performing actions on them: scheduling, dropping, + * marking, policing, etc. + * * \ingroup traffic-control * - * \brief Traffic control layer definition - * - * This layer stays between NetDevices (L2) and any network protocol (e.g. IP). - * When enabled, it is responsible to analyze packets and to perform actions on - * them: the most common is scheduling. + * \brief Traffic control layer class * + * This object represents the main interface of the Traffic Control Module. * Basically, we manage both IN and OUT directions (sometimes called RX and TX, * respectively). The OUT direction is easy to follow, since it involves * direct calls: upper layer (e.g. IP) calls the Send method on an instance of