commit 460f57c4cfef060f9bf20f5226880242e7b50add
author Spyridon Mastorakis <spiros.mastorakis@gmail.com> Wed Dec 17 00:44:14 2014 -0800
committer Alexander Afanasyev <alexander.afanasyev@ucla.edu> Sat Jan 10 01:10:54 2015 -0800
tree 72d64b03a11558d68638e19940a9ef7eb1142373
parent b4bd4b7bdf001929f5a85c318ebeae697edc3072

docs: Documentation update

Change-Id: I6f916eb822a59e980e8fb1134886c3431755119c

model/cs/content-store-with-probability.hpp

diff --git a/model/cs/content-store-with-probability.hpp b/model/cs/content-store-with-probability.hpp
index eabe12d..5ba9b58 100644
--- a/model/cs/content-store-with-probability.hpp
+++ b/model/cs/content-store-with-probability.hpp
@@ -35,7 +35,8 @@
 
 /**
  * @ingroup ndn-cs
- * @brief Special content store realization that honors Freshness parameter in Data packets
+ * @brief Special content store realization that probabilistically accepts data packet
+ *        into CS (placement policy)
  */
 template<class Policy>
 class ContentStoreWithProbability

model/cs/custom-policies/freshness-policy.hpp

diff --git a/model/cs/custom-policies/freshness-policy.hpp b/model/cs/custom-policies/freshness-policy.hpp
index 8963bd7..415ab0b 100644
--- a/model/cs/custom-policies/freshness-policy.hpp
+++ b/model/cs/custom-policies/freshness-policy.hpp
@@ -20,6 +20,8 @@
 #ifndef FRESHNESS_POLICY_H_
 #define FRESHNESS_POLICY_H_
 
+/// @cond include_hidden
+
 #include "ns3/ndnSIM/model/ndn-common.hpp"
 
 #include <boost/intrusive/options.hpp>
@@ -166,4 +168,6 @@
 } // ndn
 } // ns3
 
+/// @endcond
+
 #endif // LIFETIME_STATS_POLICY_H

model/cs/custom-policies/lifetime-stats-policy.hpp

diff --git a/model/cs/custom-policies/lifetime-stats-policy.hpp b/model/cs/custom-policies/lifetime-stats-policy.hpp
index eb8a3ee..6e81618 100644
--- a/model/cs/custom-policies/lifetime-stats-policy.hpp
+++ b/model/cs/custom-policies/lifetime-stats-policy.hpp
@@ -20,6 +20,8 @@
 #ifndef LIFETIME_STATS_POLICY_H_
 #define LIFETIME_STATS_POLICY_H_
 
+/// @cond include_hidden
+
 #include "ns3/ndnSIM/model/ndn-common.hpp"
 
 #include <boost/intrusive/options.hpp>
@@ -160,4 +162,6 @@
 } // ndn
 } // ns3
 
+/// @endcond
+
 #endif // LIFETIME_STATS_POLICY_H

model/cs/custom-policies/probability-policy.hpp

diff --git a/model/cs/custom-policies/probability-policy.hpp b/model/cs/custom-policies/probability-policy.hpp
index 3fb93a5..7ad6fd0 100644
--- a/model/cs/custom-policies/probability-policy.hpp
+++ b/model/cs/custom-policies/probability-policy.hpp
@@ -20,6 +20,8 @@
 #ifndef PROBABILITY_POLICY_H_
 #define PROBABILITY_POLICY_H_
 
+/// @cond include_hidden
+
 #include "ns3/ndnSIM/model/ndn-common.hpp"
 
 #include <boost/intrusive/options.hpp>
@@ -145,4 +147,6 @@
 } // ndn
 } // ns3
 
+/// @endcond
+
 #endif // PROBABILITY_POLICY_H

model/ndn-global-router.hpp

diff --git a/model/ndn-global-router.hpp b/model/ndn-global-router.hpp
index 76eb8f8..4713a5b 100644
--- a/model/ndn-global-router.hpp
+++ b/model/ndn-global-router.hpp
@@ -38,7 +38,7 @@
 class L3Protocol;
 
 /**
- * @ingroup ndn
+ * @ingroup ndn-helpers
  * @brief Class representing global router interface for ndnSIM
  */
 class GlobalRouter : public Object {