docs: fix capitalization in doxygen comments
Change-Id: Ibf5ee5119d12d60d382b0acef8dfd08277c18fcb
diff --git a/daemon/fw/access-strategy.hpp b/daemon/fw/access-strategy.hpp
index c33ad5c..194c9ca 100644
--- a/daemon/fw/access-strategy.hpp
+++ b/daemon/fw/access-strategy.hpp
@@ -35,16 +35,17 @@
namespace nfd::fw {
-/** \brief Access Router strategy
+/**
+ * \brief A forwarding strategy for "access" routers.
*
- * This strategy is designed for the last hop on the NDN testbed,
- * where each nexthop connects to a laptop, links are lossy, and FIB is mostly correct.
+ * This strategy is designed for the last hop on the NDN testbed,
+ * where each nexthop connects to a laptop, links are lossy, and FIB is mostly correct.
*
- * 1. Multicast the first Interest to all nexthops.
- * 2. When Data comes back, remember last working nexthop of the prefix;
- * the granularity of this knowledge is the parent of Data Name.
- * 3. Forward subsequent Interests to the last working nexthop.
- * If it doesn't respond, multicast again.
+ * 1. Multicast the first Interest to all nexthops.
+ * 2. When Data comes back, remember the last working nexthop of the prefix;
+ * the granularity of this knowledge is the parent of Data Name.
+ * 3. Forward subsequent Interests to the last working nexthop.
+ * If there is no reply, multicast again (step 1).
*/
class AccessStrategy : public Strategy
{
@@ -67,7 +68,7 @@
private: // StrategyInfo
using RttEstimator = ndn::util::RttEstimator;
- /** \brief StrategyInfo on PIT entry
+ /** \brief StrategyInfo on PIT entry.
*/
class PitInfo final : public StrategyInfo
{
@@ -82,7 +83,7 @@
scheduler::ScopedEventId rtoTimer;
};
- /** \brief StrategyInfo in measurements table
+ /** \brief StrategyInfo in measurements table.
*/
class MtInfo final : public StrategyInfo
{
@@ -104,18 +105,18 @@
RttEstimator rtt;
};
- /** \brief find per-prefix measurements for Interest
+ /** \brief Find per-prefix measurements for Interest.
*/
std::tuple<Name, MtInfo*>
findPrefixMeasurements(const pit::Entry& pitEntry);
- /** \brief get or create pre-prefix measurements for incoming Data
+ /** \brief Get or create pre-prefix measurements for incoming Data.
* \note This function creates MtInfo but doesn't update it.
*/
MtInfo*
addPrefixMeasurements(const Data& data);
- /** \brief global per-face StrategyInfo
+ /** \brief Global per-face StrategyInfo.
* \todo Currently stored inside AccessStrategy instance; should be moved
* to measurements table or somewhere else.
*/
@@ -141,7 +142,7 @@
afterReceiveRetxInterest(const Interest& interest, const FaceEndpoint& ingress,
const shared_ptr<pit::Entry>& pitEntry);
- /** \brief send to last working nexthop
+ /** \brief Send to last working nexthop.
* \return whether an Interest is sent
*/
bool
@@ -153,7 +154,7 @@
afterRtoTimeout(const weak_ptr<pit::Entry>& pitWeak,
FaceId inFaceId, FaceId firstOutFaceId);
- /** \brief multicast to all nexthops
+ /** \brief Multicast to all nexthops.
* \param exceptFace don't forward to this face; also, \p inFace is always excluded
* \return number of Interests that were sent
*/