docs: Documentation update
Change-Id: I6f916eb822a59e980e8fb1134886c3431755119c
diff --git a/utils/topology/annotated-topology-reader.cpp b/utils/topology/annotated-topology-reader.cpp
index a10cf2f..c62b7e5 100644
--- a/utils/topology/annotated-topology-reader.cpp
+++ b/utils/topology/annotated-topology-reader.cpp
@@ -495,6 +495,8 @@
}
}
+/// @cond include_hidden
+
template<class Names>
class name_writer {
public:
@@ -522,6 +524,8 @@
return name_writer<Names>(n);
}
+/// @endcond
+
void
AnnotatedTopologyReader::SaveGraphviz(const std::string& file)
{
@@ -560,4 +564,5 @@
boost::property_map<Graph, boost::vertex_name_t>::type names = get(boost::vertex_name, graph);
write_graphviz(of, graph, make_name_writer(names));
}
+
}
diff --git a/utils/topology/rocketfuel-map-reader.cpp b/utils/topology/rocketfuel-map-reader.cpp
index f5a424e..b53b03b 100644
--- a/utils/topology/rocketfuel-map-reader.cpp
+++ b/utils/topology/rocketfuel-map-reader.cpp
@@ -560,6 +560,8 @@
}
}
+/// @cond include_hidden
+
template<class Names, class Colors>
class name_color_writer {
public:
@@ -589,6 +591,8 @@
return name_color_writer<Names, Colors>(n, c);
}
+/// @endcond
+
void
RocketfuelMapReader::SaveGraphviz(const std::string& file)
{
diff --git a/utils/trie/aggregate-stats-policy.hpp b/utils/trie/aggregate-stats-policy.hpp
index 3628cc6..4d2673b 100644
--- a/utils/trie/aggregate-stats-policy.hpp
+++ b/utils/trie/aggregate-stats-policy.hpp
@@ -27,6 +27,8 @@
namespace ndn {
namespace ndnSIM {
+/// @cond include_hidden
+
/**
* @brief Traits for policy that just keeps track of number of elements
* It's doing a rather expensive job, but just in case it needs to be extended later
@@ -159,4 +161,6 @@
} // ndn
} // ns3
+/// @endcond
+
#endif // AGGREGATE_STATS_POLICY_H_
diff --git a/utils/trie/counting-policy.hpp b/utils/trie/counting-policy.hpp
index 4a74036..71331b7 100644
--- a/utils/trie/counting-policy.hpp
+++ b/utils/trie/counting-policy.hpp
@@ -20,6 +20,8 @@
#ifndef COUNTING_POLICY_H_
#define COUNTING_POLICY_H_
+/// @cond include_hidden
+
#include <boost/intrusive/options.hpp>
#include <boost/intrusive/list.hpp>
@@ -108,4 +110,6 @@
} // ndn
} // ns3
+/// @endcond
+
#endif // COUNTING_POLICY_H_
diff --git a/utils/trie/detail/functor-hook.hpp b/utils/trie/detail/functor-hook.hpp
index a638e59..17542ba 100644
--- a/utils/trie/detail/functor-hook.hpp
+++ b/utils/trie/detail/functor-hook.hpp
@@ -20,6 +20,8 @@
#ifndef FUNCTOR_HOOK_H_
#define FUNCTOR_HOOK_H_
+/// @cond include_hidden
+
#include <boost/intrusive/parent_from_member.hpp>
namespace ns3 {
@@ -73,4 +75,6 @@
} // ndn
} // ns3
+/// @endcond
+
#endif // FUNCTOR_HOOK_H_
diff --git a/utils/trie/detail/multi-policy-container.hpp b/utils/trie/detail/multi-policy-container.hpp
index cf2634f..5c3450b 100644
--- a/utils/trie/detail/multi-policy-container.hpp
+++ b/utils/trie/detail/multi-policy-container.hpp
@@ -20,6 +20,8 @@
#ifndef MULTI_POLICY_CONTAINER_H_
#define MULTI_POLICY_CONTAINER_H_
+/// @cond include_hidden
+
#include <boost/mpl/inherit_linearly.hpp>
#include <boost/mpl/at.hpp>
@@ -207,4 +209,6 @@
} // ndn
} // ns3
+/// @endcond
+
#endif // MULTI_POLICY_CONTAINER_H_
diff --git a/utils/trie/detail/multi-type-container.hpp b/utils/trie/detail/multi-type-container.hpp
index 84e2f55..f84f860 100644
--- a/utils/trie/detail/multi-type-container.hpp
+++ b/utils/trie/detail/multi-type-container.hpp
@@ -20,6 +20,8 @@
#ifndef MULTI_TYPE_CONTAINER_H_
#define MULTI_TYPE_CONTAINER_H_
+/// @cond include_hidden
+
#include <boost/mpl/inherit_linearly.hpp>
#include <boost/mpl/inherit.hpp>
#include <boost/mpl/at.hpp>
@@ -79,4 +81,6 @@
} // ndn
} // ns3
+/// @cond include_hidden
+
#endif // MULTI_TYPE_CONTAINER_H_
diff --git a/utils/trie/empty-policy.hpp b/utils/trie/empty-policy.hpp
index 404028f..237a647 100644
--- a/utils/trie/empty-policy.hpp
+++ b/utils/trie/empty-policy.hpp
@@ -20,6 +20,8 @@
#ifndef EMPTY_POLICY_H_
#define EMPTY_POLICY_H_
+/// @cond include_hidden
+
namespace ns3 {
namespace ndn {
namespace ndnSIM {
@@ -76,4 +78,6 @@
} // ndn
} // ns3
+/// @endcond
+
#endif // EMPTY_POLICY_H_
diff --git a/utils/trie/fifo-policy.hpp b/utils/trie/fifo-policy.hpp
index d58de22..44f335e 100644
--- a/utils/trie/fifo-policy.hpp
+++ b/utils/trie/fifo-policy.hpp
@@ -20,6 +20,8 @@
#ifndef FIFO_POLICY_H_
#define FIFO_POLICY_H_
+/// @cond include_hidden
+
#include <boost/intrusive/options.hpp>
#include <boost/intrusive/list.hpp>
@@ -125,4 +127,6 @@
} // ndn
} // ns3
+/// @endcond
+
#endif
diff --git a/utils/trie/lfu-policy.hpp b/utils/trie/lfu-policy.hpp
index 68137ad..6234961 100644
--- a/utils/trie/lfu-policy.hpp
+++ b/utils/trie/lfu-policy.hpp
@@ -20,6 +20,8 @@
#ifndef LFU_POLICY_H_
#define LFU_POLICY_H_
+/// @cond include_hidden
+
#include <boost/intrusive/options.hpp>
#include <boost/intrusive/set.hpp>
@@ -158,4 +160,6 @@
} // ndn
} // ns3
+/// @endcond
+
#endif // LFU_POLICY_H
diff --git a/utils/trie/lru-policy.hpp b/utils/trie/lru-policy.hpp
index fc790a3..a88b0f7 100644
--- a/utils/trie/lru-policy.hpp
+++ b/utils/trie/lru-policy.hpp
@@ -20,6 +20,8 @@
#ifndef LRU_POLICY_H_
#define LRU_POLICY_H_
+/// @cond include_hidden
+
#include <boost/intrusive/options.hpp>
#include <boost/intrusive/list.hpp>
@@ -128,4 +130,6 @@
} // ndn
} // ns3
+/// @endcond
+
#endif
diff --git a/utils/trie/multi-policy.hpp b/utils/trie/multi-policy.hpp
index 534499f..01c8951 100644
--- a/utils/trie/multi-policy.hpp
+++ b/utils/trie/multi-policy.hpp
@@ -20,6 +20,8 @@
#ifndef MULTI_POLICY_H_
#define MULTI_POLICY_H_
+/// @cond include_hidden
+
#include "detail/multi-type-container.hpp"
#include "detail/multi-policy-container.hpp"
#include "detail/functor-hook.hpp"
@@ -189,4 +191,6 @@
} // ndn
} // ns3
+/// @endcond
+
#endif // MULTI_POLICY_H_
diff --git a/utils/trie/payload-policy.hpp b/utils/trie/payload-policy.hpp
index cdf76c3..6df4e7c 100644
--- a/utils/trie/payload-policy.hpp
+++ b/utils/trie/payload-policy.hpp
@@ -20,6 +20,8 @@
#ifndef PAYLOAD_POLICY_H_
#define PAYLOAD_POLICY_H_
+/// @cond include_hidden
+
#include <boost/intrusive/options.hpp>
#include <boost/intrusive/list.hpp>
@@ -122,4 +124,6 @@
} // ndn
} // ns3
+/// @endcond
+
#endif // PAYLOAD_POLICY_H
diff --git a/utils/trie/payload-with-policy.hpp b/utils/trie/payload-with-policy.hpp
index e682fea..c4c904e 100644
--- a/utils/trie/payload-with-policy.hpp
+++ b/utils/trie/payload-with-policy.hpp
@@ -20,6 +20,8 @@
#ifndef PAYLOAD_WITH_INDEX_H_
#define PAYLOAD_WITH_INDEX_H_
+/// @cond include_hidden
+
namespace ns3 {
namespace ndn {
namespace ndnSIM {
@@ -100,4 +102,6 @@
} // ndn
} // ns3
+/// @endcond
+
#endif // PAYLOAD_WITH_POLICY_H_
diff --git a/utils/trie/persistent-policy.hpp b/utils/trie/persistent-policy.hpp
index 49301f3..669b8b2 100644
--- a/utils/trie/persistent-policy.hpp
+++ b/utils/trie/persistent-policy.hpp
@@ -20,6 +20,8 @@
#ifndef PERSISTENT_POLICY_H_
#define PERSISTENT_POLICY_H_
+/// @cond include_hidden
+
#include <boost/intrusive/options.hpp>
#include <boost/intrusive/list.hpp>
@@ -126,4 +128,6 @@
} // ndn
} // ns3
+/// @endcond
+
#endif // PERSISTENT_POLICY_H_
diff --git a/utils/trie/random-policy.hpp b/utils/trie/random-policy.hpp
index 6beaeba..813dae5 100644
--- a/utils/trie/random-policy.hpp
+++ b/utils/trie/random-policy.hpp
@@ -20,6 +20,8 @@
#ifndef RANDOM_POLICY_H_
#define RANDOM_POLICY_H_
+/// @cond include_hidden
+
#include "ns3/random-variable.h"
#include <boost/intrusive/options.hpp>
@@ -165,4 +167,6 @@
} // ndn
} // ns3
+/// @endcond
+
#endif // RANDOM_POLICY_H
diff --git a/utils/trie/trie-with-policy.hpp b/utils/trie/trie-with-policy.hpp
index 2ef3bc4..d0d54f6 100644
--- a/utils/trie/trie-with-policy.hpp
+++ b/utils/trie/trie-with-policy.hpp
@@ -20,6 +20,8 @@
#ifndef TRIE_WITH_POLICY_H_
#define TRIE_WITH_POLICY_H_
+/// @cond include_hidden
+
#include "trie.hpp"
namespace ns3 {
@@ -299,4 +301,6 @@
} // ndn
} // ns3
+/// @endcond
+
#endif // TRIE_WITH_POLICY_H_
diff --git a/utils/trie/trie.hpp b/utils/trie/trie.hpp
index 9ca8a28..28c075e 100644
--- a/utils/trie/trie.hpp
+++ b/utils/trie/trie.hpp
@@ -20,6 +20,8 @@
#ifndef TRIE_H_
#define TRIE_H_
+/// @cond include_hidden
+
#include "ns3/ndnSIM/model/ndn-common.hpp"
#include "ns3/ptr.h"
@@ -771,4 +773,6 @@
} // ndn
} // ns3
+/// @endcond
+
#endif // TRIE_H_