2
0
mirror of https://gitlab.isc.org/isc-projects/kea synced 2025-09-02 15:05:16 +00:00

[#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.
This commit is contained in:
Thomas Markwalder
2019-05-24 15:30:29 -04:00
parent 16bdc19fa6
commit 1ac890724b
13 changed files with 26 additions and 14 deletions

View File

@@ -2439,7 +2439,7 @@ PLANTUML_INCLUDE_PATH =
# Minimum value: 0, maximum value: 10000, default value: 50. # Minimum value: 0, maximum value: 10000, default value: 50.
# This tag requires that the tag HAVE_DOT is set to YES. # 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 # 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 # generated by dot. A depth value of 3 means that only nodes reachable from the

View File

@@ -78,14 +78,14 @@ public:
/// \brief Receive DHCPv4 packet from interface. /// \brief Receive DHCPv4 packet from interface.
/// ///
/// \param timeout_sec number of seconds for waiting for a packet, /// \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 /// \return received packet or nullptr if timed out
virtual dhcp::Pkt4Ptr receive4(uint32_t timeout_sec, uint32_t timeout_usec) override; virtual dhcp::Pkt4Ptr receive4(uint32_t timeout_sec, uint32_t timeout_usec) override;
/// \brief Receive DHCPv6 packet from interface. /// \brief Receive DHCPv6 packet from interface.
/// ///
/// \param timeout_sec number of seconds for waiting for a packet, /// \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 /// \return received packet or nullptr if timed out
virtual dhcp::Pkt6Ptr receive6(uint32_t timeout_sec, uint32_t timeout_usec) override; virtual dhcp::Pkt6Ptr receive6(uint32_t timeout_sec, uint32_t timeout_usec) override;

View File

@@ -44,6 +44,7 @@ enum class ExchangeType {
/// Function returns name of the specified exchange type. /// Function returns name of the specified exchange type.
/// This function is mainly for logging purposes. /// This function is mainly for logging purposes.
/// ///
/// \param os output stream to use.
/// \param xchg_type exchange type. /// \param xchg_type exchange type.
/// \return string representing name of the exchange. /// \return string representing name of the exchange.
std::ostream& operator<<(std::ostream& os, ExchangeType xchg_type); std::ostream& operator<<(std::ostream& os, ExchangeType xchg_type);

View File

@@ -57,9 +57,9 @@ static const size_t DHCPV6_IA_NA_OFFSET = 40;
/// \brief Test Control class. /// \brief Test Control class.
/// ///
/// This class is used to run the performance test with /// 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 /// 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 /// one must make sure to parse command line options by calling
/// \ref CommandOptions::parse. Failing to do this will result in an exception. /// \ref CommandOptions::parse. Failing to do this will result in an exception.
/// ///

View File

@@ -406,7 +406,8 @@ public:
/// ///
/// @param cfg_def set of of user-defined option definitions to use /// @param cfg_def set of of user-defined option definitions to use
/// when creating option instances. /// 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); void merge(CfgOptionDefPtr cfg_def, CfgOption& other);
/// @brief Re-create the option in each descriptor based on given definitions /// @brief Re-create the option in each descriptor based on given definitions

View File

@@ -157,11 +157,13 @@ public:
/// ///
/// Iterator over the definitions in each name space in this configuration: /// Iterator over the definitions in each name space in this configuration:
/// If either the definition's name or code are defined in @c other /// 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 /// Replace this configuration's definitions with the definitions
/// in @c other using @c copyTo(). /// in @c other using @c copyTo().
/// ///
/// @param other option definitions to merge in.
///
/// @warning The merge operation affects @c other. /// @warning The merge operation affects @c other.
/// Therefore, the caller must not rely on the data held in the @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 /// object after the call to @c merge. Also, the data held in @c other must

View File

@@ -676,6 +676,9 @@ protected:
/// should be called on the parent network instance (typically on /// should be called on the parent network instance (typically on
/// @c SharedNetwork4 or @c SharedNetwork6) to fetch the parent specific /// @c SharedNetwork4 or @c SharedNetwork6) to fetch the parent specific
/// value if the value is unspecified for this instance. /// 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. /// @param inheritance inheritance mode to be used.
/// ///
/// @return Option pointer fetched from this instance level or parent /// @return Option pointer fetched from this instance level or parent

View File

@@ -26,7 +26,7 @@ protected:
/// - rebind-timer, /// - rebind-timer,
/// - valid-lifetime /// - valid-lifetime
/// ///
/// @param shared_network_data Data element holding shared network /// @param network_data Data element holding shared network
/// configuration to be parsed. /// configuration to be parsed.
/// @param [out] network Pointer to a network in which parsed data is /// @param [out] network Pointer to a network in which parsed data is
/// to be stored. /// to be stored.

View File

@@ -67,7 +67,7 @@ public:
/// ///
/// \brief A standard DNS module exception that is thrown if the name parser /// \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 { class BadEscape : public NameParserException {
public: public:

View File

@@ -433,7 +433,7 @@ public:
/// @return Pointer to the created binding. /// @return Pointer to the created binding.
static MySqlBindingPtr createFloat(const float value); 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. /// provided value is specified.
/// ///
/// @tparam T Floating point type to be converted to float. /// @tparam T Floating point type to be converted to float.

View File

@@ -325,7 +325,7 @@ protected:
/// If the collection of audit entries is empty, this method simply /// If the collection of audit entries is empty, this method simply
/// returns without updating the timestamp. /// 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) { void updateLastAuditEntryTime(const db::AuditEntryCollection& audit_entries) {
// Do nothing if there are no audit entries. It is the case if // Do nothing if there are no audit entries. It is the case if
// there were no updates to the configuration. // there were no updates to the configuration.

View File

@@ -64,9 +64,9 @@ std::string trim(const std::string& instring);
/// buffer to trim /// buffer to trim
/// \param end - Forward iterator pointing to the untrimmed end of /// \param end - Forward iterator pointing to the untrimmed end of
/// the buffer to trim /// 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 /// buffer not equal to the trim value
template<typename Iterator> template<typename Iterator>
Iterator Iterator

View File

@@ -48,7 +48,12 @@ TranslatorBasic::~TranslatorBasic() {
} }
ElementPtr 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) { if (!s_val) {
isc_throw(BadValue, "value called with null"); isc_throw(BadValue, "value called with null");
} }