From 1ac890724b32021a286abc186aa4ad0c712d72c7 Mon Sep 17 00:00:00 2001 From: Thomas Markwalder Date: Fri, 24 May 2019 15:30:29 -0400 Subject: [PATCH] [#618,!339] Fixed doxygen errors doc/Doxyfile Increased DOT_GRAPH_MAX_NODES to get rid of too large error on exceptions.h Fixed numerous missing parameters in several files and some oddities that were causing doxygen errors. --- doc/Doxyfile | 2 +- src/bin/perfdhcp/perf_socket.h | 4 ++-- src/bin/perfdhcp/stats_mgr.h | 1 + src/bin/perfdhcp/test_control.h | 4 ++-- src/lib/dhcpsrv/cfg_option.h | 3 ++- src/lib/dhcpsrv/cfg_option_def.h | 4 +++- src/lib/dhcpsrv/network.h | 3 +++ src/lib/dhcpsrv/parsers/base_network_parser.h | 2 +- src/lib/dns/name.h | 2 +- src/lib/mysql/mysql_binding.h | 2 +- src/lib/process/cb_ctl_base.h | 2 +- src/lib/util/strutil.h | 4 ++-- src/lib/yang/translator.cc | 7 ++++++- 13 files changed, 26 insertions(+), 14 deletions(-) diff --git a/doc/Doxyfile b/doc/Doxyfile index e6adf7ba99..aaf32af9ce 100644 --- a/doc/Doxyfile +++ b/doc/Doxyfile @@ -2439,7 +2439,7 @@ PLANTUML_INCLUDE_PATH = # Minimum value: 0, maximum value: 10000, default value: 50. # This tag requires that the tag HAVE_DOT is set to YES. -DOT_GRAPH_MAX_NODES = 200 +DOT_GRAPH_MAX_NODES = 400 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs # generated by dot. A depth value of 3 means that only nodes reachable from the diff --git a/src/bin/perfdhcp/perf_socket.h b/src/bin/perfdhcp/perf_socket.h index bdb18ee7bb..56a8551a27 100644 --- a/src/bin/perfdhcp/perf_socket.h +++ b/src/bin/perfdhcp/perf_socket.h @@ -78,14 +78,14 @@ public: /// \brief Receive DHCPv4 packet from interface. /// /// \param timeout_sec number of seconds for waiting for a packet, - /// \param timeout_sec number of microseconds for waiting for a packet, + /// \param timeout_usec number of microseconds for waiting for a packet, /// \return received packet or nullptr if timed out virtual dhcp::Pkt4Ptr receive4(uint32_t timeout_sec, uint32_t timeout_usec) override; /// \brief Receive DHCPv6 packet from interface. /// /// \param timeout_sec number of seconds for waiting for a packet, - /// \param timeout_sec number of microseconds for waiting for a packet, + /// \param timeout_usec number of microseconds for waiting for a packet, /// \return received packet or nullptr if timed out virtual dhcp::Pkt6Ptr receive6(uint32_t timeout_sec, uint32_t timeout_usec) override; diff --git a/src/bin/perfdhcp/stats_mgr.h b/src/bin/perfdhcp/stats_mgr.h index 553b48d91f..3a6a6d036a 100644 --- a/src/bin/perfdhcp/stats_mgr.h +++ b/src/bin/perfdhcp/stats_mgr.h @@ -44,6 +44,7 @@ enum class ExchangeType { /// Function returns name of the specified exchange type. /// This function is mainly for logging purposes. /// +/// \param os output stream to use. /// \param xchg_type exchange type. /// \return string representing name of the exchange. std::ostream& operator<<(std::ostream& os, ExchangeType xchg_type); diff --git a/src/bin/perfdhcp/test_control.h b/src/bin/perfdhcp/test_control.h index af10314b97..bab51ec06e 100644 --- a/src/bin/perfdhcp/test_control.h +++ b/src/bin/perfdhcp/test_control.h @@ -57,9 +57,9 @@ static const size_t DHCPV6_IA_NA_OFFSET = 40; /// \brief Test Control class. /// /// This class is used to run the performance test with -/// with \ref TestControl::run function. This function can be executed +/// with \ref TestControl::runWrapped function. This function can be executed /// multiple times if desired because it resets TestControl's internal -/// state every time it is executed. Prior to running \ref TestControl::run, +/// state every time it is executed. Prior to running \ref TestControl::runWrapped, /// one must make sure to parse command line options by calling /// \ref CommandOptions::parse. Failing to do this will result in an exception. /// diff --git a/src/lib/dhcpsrv/cfg_option.h b/src/lib/dhcpsrv/cfg_option.h index 6cd428e634..116c289d0e 100644 --- a/src/lib/dhcpsrv/cfg_option.h +++ b/src/lib/dhcpsrv/cfg_option.h @@ -406,7 +406,8 @@ public: /// /// @param cfg_def set of of user-defined option definitions to use /// when creating option instances. - /// @param option configurations to merge with. + /// @param cfg_def option definitions to reference when merging + /// @param other option configuration to merge in. void merge(CfgOptionDefPtr cfg_def, CfgOption& other); /// @brief Re-create the option in each descriptor based on given definitions diff --git a/src/lib/dhcpsrv/cfg_option_def.h b/src/lib/dhcpsrv/cfg_option_def.h index 7b9a86ccd3..24f53a7b3d 100644 --- a/src/lib/dhcpsrv/cfg_option_def.h +++ b/src/lib/dhcpsrv/cfg_option_def.h @@ -157,11 +157,13 @@ public: /// /// Iterator over the definitions in each name space in this configuration: /// If either the definition's name or code are defined in @c other - /// then skip over the definition otherwise add it to @other. + /// then skip over the definition otherwise add it to @c other. /// /// Replace this configuration's definitions with the definitions /// in @c other using @c copyTo(). /// + /// @param other option definitions to merge in. + /// /// @warning The merge operation affects @c other. /// Therefore, the caller must not rely on the data held in the @c other /// object after the call to @c merge. Also, the data held in @c other must diff --git a/src/lib/dhcpsrv/network.h b/src/lib/dhcpsrv/network.h index 3216b9b089..dc5237138c 100644 --- a/src/lib/dhcpsrv/network.h +++ b/src/lib/dhcpsrv/network.h @@ -676,6 +676,9 @@ protected: /// should be called on the parent network instance (typically on /// @c SharedNetwork4 or @c SharedNetwork6) to fetch the parent specific /// value if the value is unspecified for this instance. + /// @param property the value to return when inheritance mode is NONE, or + /// when the mode is PARENT_NETWORK and the property has not been specified + /// by a parent network. /// @param inheritance inheritance mode to be used. /// /// @return Option pointer fetched from this instance level or parent diff --git a/src/lib/dhcpsrv/parsers/base_network_parser.h b/src/lib/dhcpsrv/parsers/base_network_parser.h index 6f3798677f..57dbf39b86 100644 --- a/src/lib/dhcpsrv/parsers/base_network_parser.h +++ b/src/lib/dhcpsrv/parsers/base_network_parser.h @@ -26,7 +26,7 @@ protected: /// - rebind-timer, /// - valid-lifetime /// - /// @param shared_network_data Data element holding shared network + /// @param network_data Data element holding shared network /// configuration to be parsed. /// @param [out] network Pointer to a network in which parsed data is /// to be stored. diff --git a/src/lib/dns/name.h b/src/lib/dns/name.h index 92d25cbb23..8871cd9889 100644 --- a/src/lib/dns/name.h +++ b/src/lib/dns/name.h @@ -67,7 +67,7 @@ public: /// /// \brief A standard DNS module exception that is thrown if the name parser -/// fails to decode a "\"-escaped sequence. +/// fails to decode a back-slash escaped sequence. /// class BadEscape : public NameParserException { public: diff --git a/src/lib/mysql/mysql_binding.h b/src/lib/mysql/mysql_binding.h index 7511bfd669..d26f28621d 100644 --- a/src/lib/mysql/mysql_binding.h +++ b/src/lib/mysql/mysql_binding.h @@ -433,7 +433,7 @@ public: /// @return Pointer to the created binding. static MySqlBindingPtr createFloat(const float value); - /// @Conditionally creates binding of float type for sending data if + /// @brief Conditionally creates binding of float type for sending data if /// provided value is specified. /// /// @tparam T Floating point type to be converted to float. diff --git a/src/lib/process/cb_ctl_base.h b/src/lib/process/cb_ctl_base.h index ad7a748e0d..7602c894e0 100644 --- a/src/lib/process/cb_ctl_base.h +++ b/src/lib/process/cb_ctl_base.h @@ -325,7 +325,7 @@ protected: /// If the collection of audit entries is empty, this method simply /// returns without updating the timestamp. /// - /// @param Reference to the collection of the fetched audit entries. + /// @param audit_entries reference to the collection of the fetched audit entries. void updateLastAuditEntryTime(const db::AuditEntryCollection& audit_entries) { // Do nothing if there are no audit entries. It is the case if // there were no updates to the configuration. diff --git a/src/lib/util/strutil.h b/src/lib/util/strutil.h index 08f400df40..cbb47632c5 100644 --- a/src/lib/util/strutil.h +++ b/src/lib/util/strutil.h @@ -64,9 +64,9 @@ std::string trim(const std::string& instring); /// buffer to trim /// \param end - Forward iterator pointing to the untrimmed end of /// the buffer to trim -/// \param val - byte value to trim off +/// \param trim_val - byte value to trim off /// -/// \retrun Iterator pointing the first character from the end of the +/// \return Iterator pointing the first character from the end of the /// buffer not equal to the trim value template Iterator diff --git a/src/lib/yang/translator.cc b/src/lib/yang/translator.cc index 834218b915..c22d805076 100644 --- a/src/lib/yang/translator.cc +++ b/src/lib/yang/translator.cc @@ -48,7 +48,12 @@ TranslatorBasic::~TranslatorBasic() { } ElementPtr -TranslatorBasic::value(S_Val s_val) { + +#ifndef HAVE_PRE_0_7_6_SYSREPO + TranslatorBasic::value(sysrepo::S_Val s_val) { +#else + TranslatorBasic::value(S_Val s_val) { +#endif if (!s_val) { isc_throw(BadValue, "value called with null"); } -- 2.47.2