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

tests/tools/nfdc/mock-nfd-mgmt-fixture.hpp

diff --git a/tests/tools/nfdc/mock-nfd-mgmt-fixture.hpp b/tests/tools/nfdc/mock-nfd-mgmt-fixture.hpp
index eb197a4..ab2ec39 100644
--- a/tests/tools/nfdc/mock-nfd-mgmt-fixture.hpp
+++ b/tests/tools/nfdc/mock-nfd-mgmt-fixture.hpp
@@ -39,7 +39,7 @@
 class MockNfdMgmtFixture : public nfd::tests::MockNfdMgmtFixture
 {
 protected:
-  /** \brief respond to FaceQuery requests
+  /** \brief Respond to FaceQuery requests.
    *  \retval true the Interest matches one of the defined patterns and is responded
    *  \retval false the Interest is not responded
    */

tests/tools/nfdc/status-fixture.hpp

diff --git a/tests/tools/nfdc/status-fixture.hpp b/tests/tools/nfdc/status-fixture.hpp
index 7616306..c82e79b 100644
--- a/tests/tools/nfdc/status-fixture.hpp
+++ b/tests/tools/nfdc/status-fixture.hpp
@@ -51,8 +51,8 @@
   }
 };
 
-/** \brief fixture to test status fetching routines in a \p Module
- *  \tparam M a subclass of \p Module
+/** \brief Fixture to test status fetching routines in a Module.
+ *  \tparam M a subclass of Module
  *  \tparam MakeValidator a callable to make a Validator for use in \p controller;
  *                        MakeValidator()(Face&, KeyChain&) should return a unique_ptr
  *                        to Validator or its subclass
@@ -71,7 +71,7 @@
   }
 
 protected: // status fetching
-  /** \brief start fetching status
+  /** \brief Start fetching status.
    *
    *  A test case should call \p fetchStatus, \p sendDataset, and \p prepareStatusOutput
    *  in this order, and then check \p statusXml and \p statusText contain the correct outputs.
@@ -90,7 +90,7 @@
     this->advanceClocks(1_ms);
   }
 
-  /** \brief prepare status output as XML and text
+  /** \brief Prepare status output as XML and text.
    *  \pre sendDataset has been invoked
    */
   void
@@ -116,7 +116,7 @@
   output_test_stream statusText;
 };
 
-/** \brief strips leading spaces on every line in expected XML
+/** \brief Strips leading spaces on every line in expected XML.
  *
  *  This allows expected XML to be written as:
  *  \code

tests/tools/nfdc/status-report.t.cpp

diff --git a/tests/tools/nfdc/status-report.t.cpp b/tests/tools/nfdc/status-report.t.cpp
index f978c57..fbff27a 100644
--- a/tests/tools/nfdc/status-report.t.cpp
+++ b/tests/tools/nfdc/status-report.t.cpp
@@ -53,9 +53,9 @@
   {
   }
 
-  /** \brief cause fetchStatus to succeed or fail
+  /** \brief Cause fetchStatus() to succeed or fail.
    *  \param res zero to succeed, non-zero to fail with specific code
-   *  \param delay duration from fetchStatus invocation to succeed or fail; must be positive
+   *  \param delay duration from fetchStatus() invocation to succeed or fail; must be positive
    */
   void
   setResult(uint32_t res, time::nanoseconds delay)