From: Francis Dupont Date: Thu, 30 Apr 2020 13:22:35 +0000 (+0200) Subject: [#1210] Fixed some doxygen issues X-Git-Tag: Kea-1.7.8~98 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=d9258258d7f3ba8445dd7741662e7d7ea9bcbdd8;p=thirdparty%2Fkea.git [#1210] Fixed some doxygen issues --- diff --git a/src/bin/d2/dns_client.h b/src/bin/d2/dns_client.h index 2f3b55f260..41423be889 100644 --- a/src/bin/d2/dns_client.h +++ b/src/bin/d2/dns_client.h @@ -1,4 +1,4 @@ -// Copyright (C) 2013-2015,2017 Internet Systems Consortium, Inc. ("ISC") +// Copyright (C) 2013-2020 Internet Systems Consortium, Inc. ("ISC") // // This Source Code Form is subject to the terms of the Mozilla Public // License, v. 2.0. If a copy of the MPL was not distributed with this @@ -102,8 +102,8 @@ public: /// @name Copy constructor and assignment operator /// /// Copy constructor and assignment operator are private because there are - /// no use cases when @DNSClient instance will need to be copied. Also, it - /// is desired to avoid copying @DNSClient::impl_ pointer and external + /// no use cases when a DNSClient instance will need to be copied. Also, it + /// is desired to avoid copying a DNSClient::impl_ pointer and external /// callbacks. /// //@{ diff --git a/src/bin/dhcp4/dhcp4_srv.h b/src/bin/dhcp4/dhcp4_srv.h index 28778e1fbe..b8ae778757 100644 --- a/src/bin/dhcp4/dhcp4_srv.h +++ b/src/bin/dhcp4/dhcp4_srv.h @@ -153,6 +153,7 @@ public: private: + /// @public /// @brief Assign class using vendor-class-identifier option /// /// @note This is the first part of @ref classifyPacket @@ -1027,6 +1028,7 @@ protected: private: + /// @public /// @brief Assign class using vendor-class-identifier option /// /// @note This is the first part of @ref classifyPacket diff --git a/src/bin/perfdhcp/stats_mgr.h b/src/bin/perfdhcp/stats_mgr.h index 84f7eaa5dc..87e441c451 100644 --- a/src/bin/perfdhcp/stats_mgr.h +++ b/src/bin/perfdhcp/stats_mgr.h @@ -1089,7 +1089,7 @@ public: /// counters. /// /// \param clean_report value to generate easy to parse report. - /// \param sep_ string used as separator if clean_report enabled.. + /// \param clean_sep string used as separator if clean_report enabled.. void printIntermediateStats(bool clean_report, std::string clean_sep) const { std::ostringstream stream_sent; diff --git a/src/bin/perfdhcp/test_control.h b/src/bin/perfdhcp/test_control.h index 79cb763153..7d1dd32bd1 100644 --- a/src/bin/perfdhcp/test_control.h +++ b/src/bin/perfdhcp/test_control.h @@ -568,7 +568,7 @@ protected: /// Generate list of addresses and check for uniqueness. /// /// \param pkt6 object representing received DHCPv6 packet - /// \param ExhchangeType enum value. + /// \param xchg_type ExchangeType enum value. void address6Uniqueness(const dhcp::Pkt6Ptr& pkt6, ExchangeType xchg_type); /// \brief Process received v4 addresses uniqueness. @@ -576,7 +576,7 @@ protected: /// Generate list of addresses and check for uniqueness. /// /// \param pkt4 object representing received DHCPv4 packet - /// \param ExchangeType enum value. + /// \param xchg_type ExchangeType enum value. void address4Uniqueness(const dhcp::Pkt4Ptr& pkt4, ExchangeType xchg_type); /// \brief add unique address to already assigned list. @@ -584,8 +584,8 @@ protected: /// Add address and/or prefix to unique set if it's not already there, /// otherwise increment the number of non unique addresses. /// - /// \param std::set set of addresses that should be added to unique list - /// \param ExchangeType enum value. + /// \param current set of addresses that should be added to unique list + /// \param xchg_type ExchangeType enum value. void addUniqeAddr(const std::set& current, ExchangeType xchg_type) { switch(xchg_type) { case ExchangeType::SA: { @@ -648,7 +648,7 @@ protected: /// If address is released we should remove it from both /// advertised (offered) and assigned sets. /// - /// \param std::string holding value of unique address. + /// \param addr holding value of unique address. void removeUniqueAddr(const std::set& addr) { for (auto addr_it = addr.begin(); addr_it != addr.end(); ++addr_it) { auto it = unique_address_.find(*addr_it); diff --git a/src/hooks/dhcp/high_availability/ha_service.h b/src/hooks/dhcp/high_availability/ha_service.h index 24ec003be7..8f438920ea 100644 --- a/src/hooks/dhcp/high_availability/ha_service.h +++ b/src/hooks/dhcp/high_availability/ha_service.h @@ -874,7 +874,7 @@ protected: /// flagged as ready to read. It is installed by the invocation to /// register the socket with IfaceMgr made in @ref clientConnectHandler. /// - /// The handler calls @c HttpClient::closeIfOutOfBandwidth() to catch + /// The handler calls @c http::HttpClient::closeIfOutOfBandwidth() to catch /// and close any sockets that have gone ready outside of transactions. /// /// We do this in case the other peer closed the socket (e.g. idle timeout), diff --git a/src/hooks/dhcp/lease_cmds/lease_cmds.cc b/src/hooks/dhcp/lease_cmds/lease_cmds.cc index b54761ed86..24a0e39122 100644 --- a/src/hooks/dhcp/lease_cmds/lease_cmds.cc +++ b/src/hooks/dhcp/lease_cmds/lease_cmds.cc @@ -354,8 +354,8 @@ public: /// @brief Fetches an IP address parameter from a map of parameters /// @param map of parameters in which to look /// @name name of the parameter desired - /// @family expected protocol family of the address parameter, AF_INET - /// or AF_INET6 + /// @param family expected protocol family of the address parameter, + /// AF_INET or AF_INET6 /// @return IOAddress containing the value of the parameter. /// @throw BadValue if the parameter is missing or invalid IOAddress getAddressParam(ConstElementPtr params, const std::string name, diff --git a/src/lib/dhcpsrv/cql_lease_mgr.cc b/src/lib/dhcpsrv/cql_lease_mgr.cc index 672ba16a97..d85587f494 100644 --- a/src/lib/dhcpsrv/cql_lease_mgr.cc +++ b/src/lib/dhcpsrv/cql_lease_mgr.cc @@ -161,7 +161,7 @@ public: /// Fills in the CQL_BIND array for sending data in the Lease4 object to /// the database. Used for DELETE statements. /// - /// @param address address of the lease to be deleted + /// @param lease Deleted lease information. /// @param data lease info in CQL format will be stored here /// @param statement_tag tag identifying the query (optional) void createBindForDelete(const Lease4Ptr &lease, diff --git a/src/lib/dhcpsrv/network.h b/src/lib/dhcpsrv/network.h index f73064c35f..0884e4ab06 100644 --- a/src/lib/dhcpsrv/network.h +++ b/src/lib/dhcpsrv/network.h @@ -693,7 +693,7 @@ public: /// @brief Sets new store-extended-info /// - /// @param store-extended-info New value to use. + /// @param store_extended_info New value to use. void setStoreExtendedInfo(const util::Optional& store_extended_info) { store_extended_info_ = store_extended_info; } diff --git a/src/lib/dhcpsrv/parsers/dhcp_parsers.h b/src/lib/dhcpsrv/parsers/dhcp_parsers.h index feebec53a2..3f004c1392 100644 --- a/src/lib/dhcpsrv/parsers/dhcp_parsers.h +++ b/src/lib/dhcpsrv/parsers/dhcp_parsers.h @@ -1,4 +1,4 @@ -// Copyright (C) 2013-2019 Internet Systems Consortium, Inc. ("ISC") +// Copyright (C) 2013-2020 Internet Systems Consortium, Inc. ("ISC") // // This Source Code Form is subject to the terms of the Mozilla Public // License, v. 2.0. If a copy of the MPL was not distributed with this @@ -803,8 +803,6 @@ public: /// /// @param [out] subnets Container where parsed subnets will be stored. /// @param subnets_list pointer to a list of IPv6 subnets - /// @param check_iface Check if the specified interface exists in - /// the system. /// @return Number of subnets created. size_t parse(Subnet6Collection& subnets, data::ConstElementPtr subnets_list); diff --git a/src/lib/dhcpsrv/parsers/shared_network_parser.h b/src/lib/dhcpsrv/parsers/shared_network_parser.h index cc9c9fb02c..1603f85663 100644 --- a/src/lib/dhcpsrv/parsers/shared_network_parser.h +++ b/src/lib/dhcpsrv/parsers/shared_network_parser.h @@ -1,4 +1,4 @@ -// Copyright (C) 2017-2019 Internet Systems Consortium, Inc. ("ISC") +// Copyright (C) 2017-2020 Internet Systems Consortium, Inc. ("ISC") // // This Source Code Form is subject to the terms of the Mozilla Public // License, v. 2.0. If a copy of the MPL was not distributed with this @@ -54,8 +54,6 @@ public: /// /// @param shared_network_data Data element holding shared network /// configuration to be parsed. - /// @param check_iface Check if the specified interface exists in - /// the system. /// /// @return Pointer to an object representing shared network. /// @throw DhcpConfigError when shared network configuration is invalid. diff --git a/src/lib/hooks/library_handle.h b/src/lib/hooks/library_handle.h index 288d68381b..bc1de1729a 100644 --- a/src/lib/hooks/library_handle.h +++ b/src/lib/hooks/library_handle.h @@ -73,7 +73,7 @@ public: /// used. Note: although -1 is a valid argument value for /// @ref isc::hooks::CalloutManager::setLibraryIndex(), in this class /// it is used as a sentinel to indicate that the library index in - /// @ref isc::util::CalloutManager should not be set or reset. + /// @ref isc::hooks::CalloutManager should not be set or reset. LibraryHandle(CalloutManager& manager, int index = -1) : callout_manager_(manager), index_(index) {} diff --git a/src/lib/stats/stats_mgr.h b/src/lib/stats/stats_mgr.h index 49ab17ca7e..9723c6b0ae 100644 --- a/src/lib/stats/stats_mgr.h +++ b/src/lib/stats/stats_mgr.h @@ -472,7 +472,7 @@ private: /// method. StatsMgr(); - /// @private + /// @public /// @brief Sets a given statistic to specified value (internal version). /// @@ -496,7 +496,7 @@ private: } } - /// @private + /// @public /// @brief Adds specified value to a given statistic (internal version). /// @@ -525,7 +525,7 @@ private: } } - /// @private + /// @public /// @brief Adds a new observation. /// @@ -536,7 +536,7 @@ private: /// @param stat observation void addObservation(const ObservationPtr& stat); - /// @private + /// @public /// @brief Adds a new observation in a thread safe context. ///