docs: wrote Doxygen comments for all files
refs: #4118
Change-Id: Ib0e7f1926cdabcca5aa401b59b24519412a099f7
diff --git a/src/update/nfd-rib-commands.hpp b/src/update/nfd-rib-commands.hpp
index 39ecb5f..b259b7e 100644
--- a/src/update/nfd-rib-commands.hpp
+++ b/src/update/nfd-rib-commands.hpp
@@ -19,6 +19,21 @@
* NLSR, e.g., in COPYING.md file. If not, see <http://www.gnu.org/licenses/>.
**/
+/*! \file
+ * Define parameters for NFD RIB commands
+ *
+ * When validating an NFD RIB command, NLSR is only concerned with the
+ * name in the command. However, a request is rejected if it has
+ * unsolicited fields, so the origin, which is set by NFD's RIB, must
+ * be considered optional. We consider these to be secure because they
+ * are currently only received over the localhost prefix. These serve
+ * to support NFD RIB to NLSR route readvertising.
+ *
+ * \sa NfdRibCommandProcessor
+ * \sa nlsr::Nlsr::LOCALHOST_PREFIX
+ * \sa nlsr::Nlsr::getDispatcher
+ */
+
#ifndef UPDATE_NFD_RIB_COMMANDS_HPP
#define UPDATE_NFD_RIB_COMMANDS_HPP
diff --git a/src/update/prefix-update-commands.hpp b/src/update/prefix-update-commands.hpp
index 9cb2790..ce851a9 100644
--- a/src/update/prefix-update-commands.hpp
+++ b/src/update/prefix-update-commands.hpp
@@ -19,6 +19,18 @@
* NLSR, e.g., in COPYING.md file. If not, see <http://www.gnu.org/licenses/>.
**/
+/*! \file
+ * Define parameters for commands to manipulate advertised name prefixes
+ *
+ * These classes serve to define what parameters are required for
+ * Prefix Update commands. We assume these commands are secure because
+ * they are received on the localhost prefix. We require that a name
+ * be present to action upon, and also that our response have a
+ * name. Responses are only sent on failures.
+ *
+ * \sa PrefixUpdateProcessor
+ */
+
#ifndef NLSR_UPDATE_PREFIX_UPDATE_COMMANDS_HPP
#define NLSR_UPDATE_PREFIX_UPDATE_COMMANDS_HPP
diff --git a/src/update/prefix-update-processor.hpp b/src/update/prefix-update-processor.hpp
index 6ee9506..52780e6 100644
--- a/src/update/prefix-update-processor.hpp
+++ b/src/update/prefix-update-processor.hpp
@@ -55,6 +55,18 @@
ndn::KeyChain& keyChain,
std::shared_ptr<ndn::CertificateCacheTtl> certificateCache,
security::CertificateStore& certStore);
+
+ /*! \brief Load the validator's configuration from a section of a
+ * configuration file.
+ * \sa ConfFileProcessor::processConfFile
+ * \sa ConfFileProcessor::processConfSectionSecurity
+ *
+ * Loads the state of the validator for prefix update commands by
+ * reading a section from a configuration file. This function is
+ * expecting the section to be from a Boost property tree object.
+ *
+ * \throws PrefixUpdateProcessor::Error If configuration fails to load successfully
+ */
void
loadValidator(ConfigSection section, const std::string& filename);