commit aa9e3b21481a34af5d3234248b16aca316929293
author Davide Pesavento <davidepesa@gmail.com> Fri Oct 21 17:00:07 2022 -0400
committer Davide Pesavento <davidepesa@gmail.com> Sat Oct 29 21:45:24 2022 -0400
tree 590d115a0eeffba369b8f936c56cba9a72929a5e
parent b83d3df256a9aa7d50b19c8a2c14172b74a38378

docs: fix capitalization in doxygen comments

Change-Id: Ibf5ee5119d12d60d382b0acef8dfd08277c18fcb

tools/nfdc/face-helpers.hpp

diff --git a/tools/nfdc/face-helpers.hpp b/tools/nfdc/face-helpers.hpp
index 5c4ea18..1ceb976 100644
--- a/tools/nfdc/face-helpers.hpp
+++ b/tools/nfdc/face-helpers.hpp
@@ -34,7 +34,7 @@
 using ndn::nfd::FaceStatus;
 
 /**
- * \brief Procedure to find a face
+ * \brief Procedure to find a face.
  */
 class FindFace : noncopyable
 {
@@ -57,19 +57,19 @@
   explicit
   FindFace(ExecuteContext& ctx);
 
-  /** \brief find face by FaceUri
+  /** \brief Find face by FaceUri.
    *  \pre execute has not been invoked
    */
   Code
   execute(const FaceUri& faceUri, bool allowMulti = false);
 
-  /** \brief find face by FaceId
+  /** \brief Find face by FaceId.
    *  \pre execute has not been invoked
    */
   Code
   execute(uint64_t faceId);
 
-  /** \brief find face by FaceId or FaceUri
+  /** \brief Find face by FaceId or FaceUri.
    *  \param faceIdOrUri either a FaceId (uint64_t) or a FaceUri
    *  \param allowMulti effective only if \p faceIdOrUri contains a FaceUri
    *  \throw ndn::bad_any_cast faceIdOrUri is neither uint64_t nor FaceUri
@@ -77,7 +77,7 @@
   Code
   execute(const std::any& faceIdOrUri, bool allowMulti = false);
 
-  /** \brief find face by FaceQueryFilter
+  /** \brief Find face by FaceQueryFilter.
    *  \pre execute has not been invoked
    */
   Code
@@ -114,7 +114,7 @@
     return m_errorReason;
   }
 
-  /** \brief print results for disambiguation
+  /** \brief Print results for disambiguation.
    */
   void
   printDisambiguation(std::ostream& os, DisambiguationStyle style) const;
@@ -123,7 +123,7 @@
   std::optional<FaceUri>
   canonize(const std::string& fieldName, const FaceUri& uri);
 
-  /** \brief retrieve FaceStatus from filter
+  /** \brief Retrieve FaceStatus from filter.
    *  \post m_res == Code::OK and m_results is populated if retrieval succeeds
    *  \post m_res == Code::ERROR and m_errorReason is set if retrieval fails
    */
@@ -139,14 +139,14 @@
 };
 
 /**
- * \brief Canonize a FaceUri
+ * \brief Canonize a FaceUri.
  * \return canonical FaceUri (nullopt on failure) and error string
  */
 std::pair<std::optional<FaceUri>, std::string>
 canonize(ExecuteContext& ctx, const FaceUri& uri);
 
 /**
- * \brief Helper to generate exit code and error message for face canonization failures
+ * \brief Helper to generate exit code and error message for face canonization failures.
  * \param uri The FaceUri
  * \param error The error string returned by the canonization process
  * \param field An optional field identifier to include with the message