]> git.ipfire.org Git - thirdparty/kea.git/commitdiff
[#618,!339] Fixed doxygen errors
authorThomas Markwalder <tmark@isc.org>
Fri, 24 May 2019 19:30:29 +0000 (15:30 -0400)
committerThomas Markwalder <tmark@isc.org>
Fri, 24 May 2019 19:30:29 +0000 (15:30 -0400)
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.

13 files changed:
doc/Doxyfile
src/bin/perfdhcp/perf_socket.h
src/bin/perfdhcp/stats_mgr.h
src/bin/perfdhcp/test_control.h
src/lib/dhcpsrv/cfg_option.h
src/lib/dhcpsrv/cfg_option_def.h
src/lib/dhcpsrv/network.h
src/lib/dhcpsrv/parsers/base_network_parser.h
src/lib/dns/name.h
src/lib/mysql/mysql_binding.h
src/lib/process/cb_ctl_base.h
src/lib/util/strutil.h
src/lib/yang/translator.cc

index e6adf7ba99ca778f2422df67bb449d132ea0a763..aaf32af9ce0c4a4ee60bcb09928d474aca664be8 100644 (file)
@@ -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
index bdb18ee7bb9a4dc7d19da65899e52476c9fa7b76..56a8551a273bc0bcb4a8b65e7835b7b99342bbda 100644 (file)
@@ -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;
 
index 553b48d91fb4e05fa2e26c424abd48b84d904cc2..3a6a6d036a5760a59b47b733ba4717dc5bb204e9 100644 (file)
@@ -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);
index af10314b97a81952916ca26db557696df22019d6..bab51ec06e918e4e5bf0057448988ffff53f0f0b 100644 (file)
@@ -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.
 ///
index 6cd428e634ffc556e641c35eabb419bd98cac50a..116c289d0e6e605a0efaa18a8a2adc307588dc0e 100644 (file)
@@ -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
index 7b9a86ccd3166ebb1c954253d78d95a0f7fb1fec..24f53a7b3d1f24ec90319224e43ea1128307d616 100644 (file)
@@ -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 @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
index 3216b9b08974c5026f8bcace1ee60036ecf3ecc2..dc5237138cdd6662b12537b5ed306b3493e5daa1 100644 (file)
@@ -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
index 6f3798677fa24943cdc264b6a0f07d7f744aaa2f..57dbf39b86b6aa31ce27619bf382d685b0d265de 100644 (file)
@@ -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.
index 92d25cbb237d062f7e75bf1c9007188f388f6fb1..8871cd988935dad8bf914a1c6c69989b372a21e9 100644 (file)
@@ -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:
index 7511bfd669aed3606b454035417ff09f29aa26ae..d26f28621de55e54f35716a588fd7d284ac21087 100644 (file)
@@ -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.
index ad7a748e0d3c1ec673ff1980578f899f6f58b864..7602c894e0582c42d3137ce0821922cef41982f1 100644 (file)
@@ -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.
index 08f400df40af9d66d64c223c922502249dcb0cf9..cbb47632c5fc67b1bf53bad189f8b4db651c7299 100644 (file)
@@ -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<typename Iterator>
 Iterator
index 834218b915570ee1c27643822a237f1cc53b0e72..c22d805076b2527616cb3b028160f67f484b6dbc 100644 (file)
@@ -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");
     }