docs: fix capitalization in doxygen comments
Change-Id: Ibf5ee5119d12d60d382b0acef8dfd08277c18fcb
diff --git a/daemon/rib/readvertise/client-to-nlsr-readvertise-policy.hpp b/daemon/rib/readvertise/client-to-nlsr-readvertise-policy.hpp
index be76597..963c9c1 100644
--- a/daemon/rib/readvertise/client-to-nlsr-readvertise-policy.hpp
+++ b/daemon/rib/readvertise/client-to-nlsr-readvertise-policy.hpp
@@ -30,12 +30,12 @@
namespace nfd::rib {
-/** \brief a policy to readvertise routes registered by end hosts into NLSR
+/** \brief A policy to readvertise routes registered by end hosts into NLSR.
*/
class ClientToNlsrReadvertisePolicy : public ReadvertisePolicy
{
public:
- /** \brief advertise if the route's origin is client
+ /** \brief Advertise if the route's origin is client.
*
* If the route origin is "client" (typically from auto prefix propagation), readvertise it
* using the default signing identity.
diff --git a/daemon/rib/readvertise/host-to-gateway-readvertise-policy.hpp b/daemon/rib/readvertise/host-to-gateway-readvertise-policy.hpp
index 63b4fc8..44506e5 100644
--- a/daemon/rib/readvertise/host-to-gateway-readvertise-policy.hpp
+++ b/daemon/rib/readvertise/host-to-gateway-readvertise-policy.hpp
@@ -33,7 +33,7 @@
namespace nfd::rib {
-/** \brief a policy to readvertise routes registered by local applications into remote gateway
+/** \brief A policy to readvertise routes registered by local applications into remote gateway.
*/
class HostToGatewayReadvertisePolicy : public ReadvertisePolicy
{
diff --git a/daemon/rib/readvertise/nfd-rib-readvertise-destination.hpp b/daemon/rib/readvertise/nfd-rib-readvertise-destination.hpp
index ab2f710..5ed5f52 100644
--- a/daemon/rib/readvertise/nfd-rib-readvertise-destination.hpp
+++ b/daemon/rib/readvertise/nfd-rib-readvertise-destination.hpp
@@ -35,7 +35,7 @@
namespace nfd::rib {
-/** \brief a readvertise destination using NFD RIB management protocol
+/** \brief A readvertise destination using NFD RIB management protocol.
*/
class NfdRibReadvertiseDestination : public ReadvertiseDestination
{
@@ -46,14 +46,14 @@
const ndn::nfd::ControlParameters& parameters =
ndn::nfd::ControlParameters().setOrigin(ndn::nfd::ROUTE_ORIGIN_CLIENT));
- /** \brief add a name prefix into NFD RIB
+ /** \brief Add a name prefix into NFD RIB.
*/
void
advertise(const ReadvertisedRoute& rr,
std::function<void()> successCb,
std::function<void(const std::string&)> failureCb) override;
- /** \brief remove a name prefix from NFD RIB
+ /** \brief Remove a name prefix from NFD RIB.
*/
void
withdraw(const ReadvertisedRoute& rr,
diff --git a/daemon/rib/readvertise/readvertise-destination.hpp b/daemon/rib/readvertise/readvertise-destination.hpp
index 045483a..95726bd 100644
--- a/daemon/rib/readvertise/readvertise-destination.hpp
+++ b/daemon/rib/readvertise/readvertise-destination.hpp
@@ -30,7 +30,7 @@
namespace nfd::rib {
-/** \brief a destination to readvertise into
+/** \brief A destination to readvertise into.
*/
class ReadvertiseDestination : noncopyable
{
@@ -59,7 +59,7 @@
setAvailability(bool isAvailable);
public:
- /** \brief signals when the destination becomes available or unavailable
+ /** \brief Signals when the destination becomes available or unavailable.
*/
signal::Signal<ReadvertiseDestination, bool> afterAvailabilityChange;
diff --git a/daemon/rib/readvertise/readvertise-policy.hpp b/daemon/rib/readvertise/readvertise-policy.hpp
index 3e4456e..94d178f 100644
--- a/daemon/rib/readvertise/readvertise-policy.hpp
+++ b/daemon/rib/readvertise/readvertise-policy.hpp
@@ -32,7 +32,7 @@
namespace nfd::rib {
-/** \brief a decision made by readvertise policy
+/** \brief A decision made by readvertise policy.
*/
struct ReadvertiseAction
{
@@ -40,7 +40,7 @@
ndn::security::SigningInfo signer; ///< credentials for command signing
};
-/** \brief a policy to decide whether to readvertise a route, and what prefix to readvertise
+/** \brief A policy to decide whether to readvertise a route, and what prefix to readvertise.
*/
class ReadvertisePolicy : noncopyable
{
@@ -48,7 +48,7 @@
virtual
~ReadvertisePolicy() = default;
- /** \brief decide whether to readvertise a route, and what prefix to readvertise
+ /** \brief Decide whether to readvertise a route, and what prefix to readvertise.
*/
virtual std::optional<ReadvertiseAction>
handleNewRoute(const RibRouteRef& ribRoute) const = 0;
diff --git a/daemon/rib/readvertise/readvertise.hpp b/daemon/rib/readvertise/readvertise.hpp
index 88b11aa..19274c9 100644
--- a/daemon/rib/readvertise/readvertise.hpp
+++ b/daemon/rib/readvertise/readvertise.hpp
@@ -33,7 +33,7 @@
namespace nfd::rib {
-/** \brief readvertise a subset of routes to a destination according to a policy
+/** \brief Readvertise a subset of routes to a destination according to a policy.
*
* The Readvertise class allows RIB routes to be readvertised to a destination such as a routing
* protocol daemon or another NFD-RIB. It monitors the RIB for route additions and removals,
@@ -72,7 +72,7 @@
ReadvertisedRouteContainer m_rrs;
/**
- * \brief maps from RIB route to readvertised route derived from RIB route(s)
+ * \brief Map from RIB route to readvertised route derived from RIB route(s).
*/
std::map<RibRouteRef, ReadvertisedRouteContainer::iterator> m_routeToRr;
diff --git a/daemon/rib/readvertise/readvertised-route.hpp b/daemon/rib/readvertise/readvertised-route.hpp
index e4be12c..a57fe70 100644
--- a/daemon/rib/readvertise/readvertised-route.hpp
+++ b/daemon/rib/readvertise/readvertised-route.hpp
@@ -33,7 +33,7 @@
namespace nfd::rib {
-/** \brief state of a readvertised route
+/** \brief State of a readvertised route.
*/
class ReadvertisedRoute : noncopyable
{