From 485474ec0bcd5fd73743a040cbad326a458e6390 Mon Sep 17 00:00:00 2001
From: Alberto Compagno <acompagn+fdio@cisco.com>
Date: Tue, 5 May 2020 12:12:21 +0200
Subject: [HICN-606] Added doxygen documentation

Signed-off-by: Alberto Compagno <acompagn+fdio@cisco.com>
Change-Id: If2bf7f4f310adf6adbbb9ea29eafcb2a0ee40d54
---
 hicn-plugin/src/strategies/dpo_mw.h      | 8 ++++++++
 hicn-plugin/src/strategies/dpo_rr.h      | 9 +++++++++
 hicn-plugin/src/strategies/strategy_mw.h | 7 +++++++
 hicn-plugin/src/strategies/strategy_rr.h | 7 +++++++
 4 files changed, 31 insertions(+)

(limited to 'hicn-plugin/src/strategies')

diff --git a/hicn-plugin/src/strategies/dpo_mw.h b/hicn-plugin/src/strategies/dpo_mw.h
index 887c7003a..433c415fb 100644
--- a/hicn-plugin/src/strategies/dpo_mw.h
+++ b/hicn-plugin/src/strategies/dpo_mw.h
@@ -19,6 +19,14 @@
 #include <vnet/dpo/dpo.h>
 #include "../strategy_dpo_ctx.h"
 
+/**
+ * @file dpo_mw.h
+ *
+ * This file implements the strategy vtf (see strategy.h) and
+ * the dpo vft (see strategy_dpo_manager.h) for the strategy
+ * maximum weight
+ */
+
 #define DEFAULT_WEIGHT 0
 
 typedef struct hicn_strategy_mw_ctx_s
diff --git a/hicn-plugin/src/strategies/dpo_rr.h b/hicn-plugin/src/strategies/dpo_rr.h
index e80c0302a..e4e5b5372 100644
--- a/hicn-plugin/src/strategies/dpo_rr.h
+++ b/hicn-plugin/src/strategies/dpo_rr.h
@@ -19,6 +19,15 @@
 #include <vnet/dpo/dpo.h>
 #include "../strategy_dpo_ctx.h"
 
+/**
+ * @file dpo_rr.h
+ *
+ * This file implements the strategy vtf (see strategy.h) and
+ * the dpo vft (see strategy_dpo_manager.h) for the strategy
+ * round robin.
+ */
+
+
 /**
  * Context for the Round Robin strategy
  */
diff --git a/hicn-plugin/src/strategies/strategy_mw.h b/hicn-plugin/src/strategies/strategy_mw.h
index f64f1fdc7..9e0078b23 100644
--- a/hicn-plugin/src/strategies/strategy_mw.h
+++ b/hicn-plugin/src/strategies/strategy_mw.h
@@ -18,6 +18,13 @@
 
 #include "../strategy.h"
 
+/**
+ * @file strategy_mw.h
+ *
+ * This file implements the maximum weight strategy. In this
+ * strategy the choosen next hop is one with the maximum weight.
+ */
+
 /**
  * @brief Return the vft for the Maximum Weight strategy
  */
diff --git a/hicn-plugin/src/strategies/strategy_rr.h b/hicn-plugin/src/strategies/strategy_rr.h
index 3936845fe..4dfe76b43 100644
--- a/hicn-plugin/src/strategies/strategy_rr.h
+++ b/hicn-plugin/src/strategies/strategy_rr.h
@@ -18,6 +18,13 @@
 
 #include "../strategy.h"
 
+/**
+ * @file strategy_rr.h
+ *
+ * This file implements the round robin strategy. In this
+ * strategy the next hop is choosen in a round robin way.
+ */
+
 /**
  * @brief Return the vft for the Round Robin strategy
  */
-- 
cgit 1.2.3-korg