docs: wrote Doxygen comments for all files
refs: #4118
Change-Id: Ib0e7f1926cdabcca5aa401b59b24519412a099f7
diff --git a/src/conf-parameter.hpp b/src/conf-parameter.hpp
index e21e547..29f9f9c 100644
--- a/src/conf-parameter.hpp
+++ b/src/conf-parameter.hpp
@@ -106,6 +106,17 @@
HYPERBOLIC_STATE_DEFAULT = 0
};
+/*! \brief A class to house all the configuration parameters for NLSR.
+ *
+ * This class is conceptually a singleton (but not mechanically) which
+ * is just a collection of attributes that serve as a
+ * separation-of-data for NLSR's configuration variables. NLSR refers
+ * to an instance of this class for all its configuration
+ * parameters. This object is typically populated by a
+ * ConfFileProcessor reading a configuration file.
+ *
+ * \sa nlsr::ConfFileProcessor
+ */
class ConfParameter
{
@@ -441,6 +452,8 @@
return m_log4CxxConfPath;
}
+ /*! \brief Dump the current state of all attributes to the log.
+ */
void
writeLog();