docs: wrote Doxygen comments for all files
refs: #4118
Change-Id: Ib0e7f1926cdabcca5aa401b59b24519412a099f7
diff --git a/src/route/routing-table.hpp b/src/route/routing-table.hpp
index 903ca79..b138c9d 100644
--- a/src/route/routing-table.hpp
+++ b/src/route/routing-table.hpp
@@ -23,15 +23,15 @@
#ifndef NLSR_ROUTING_TABLE_HPP
#define NLSR_ROUTING_TABLE_HPP
+#include "conf-parameter.hpp"
+#include "routing-table-entry.hpp"
+
#include <iostream>
#include <utility>
#include <string>
#include <boost/cstdint.hpp>
#include <ndn-cxx/util/scheduler.hpp>
-#include "conf-parameter.hpp"
-#include "routing-table-entry.hpp"
-
namespace nlsr {
class Nlsr;
@@ -48,33 +48,34 @@
}
/*! \brief Calculates a list of next hops for each router in the network.
- \param pnlsr The NLSR object that contains the LSAs needed for adj. info.
-
- Calculates the list of next hops to every other router in the network.
- */
+ * \param pnlsr The NLSR object that contains the LSAs needed for adj. info.
+ *
+ * Calculates the list of next hops to every other router in the network.
+ */
void
calculate(Nlsr& pnlsr);
/*! \brief Adds a next hop to a routing table entry.
- \param destRouter The destination router whose RTE we want to modify.
- \param nh The next hop to add to the RTE.
- */
+ * \param destRouter The destination router whose RTE we want to modify.
+ * \param nh The next hop to add to the RTE.
+ */
void
addNextHop(const ndn::Name& destRouter, NextHop& nh);
/*! \brief Adds a next hop to a routing table entry in a dry run scenario.
- \param destRouter The destination router whose RTE we want to modify.
- \param nh The next hop to add to the router.
- */
+ * \param destRouter The destination router whose RTE we want to modify.
+ * \param nh The next hop to add to the router.
+ */
void
addNextHopToDryTable(const ndn::Name& destRouter, NextHop& nh);
RoutingTableEntry*
findRoutingTableEntry(const ndn::Name& destRouter);
- /*! \brief Schedules a calculation event in the event scheduler.
- \param pnlsr The NLSR whose scheduling status is needed.
- */
+ /*! \brief Schedules a calculation event in the event scheduler only
+ * if one isn't already scheduled.
+ * \param pnlsr The NLSR whose scheduling status is needed.
+ */
void
scheduleRoutingTableCalculation(Nlsr& pnlsr);
@@ -131,4 +132,4 @@
} // namespace nlsr
-#endif //NLSR_ROUTING_TABLE_HPP
+#endif // NLSR_ROUTING_TABLE_HPP