From: Marcin Siodelski Date: Mon, 10 Sep 2018 08:24:09 +0000 (+0200) Subject: [#28,!20] Fixed doxygen warnings in DHCP config backend classes. X-Git-Tag: 134-bugs--xcode-10_base~15 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=b10294549eec106fca04a6f56af8a41b2465503d;p=thirdparty%2Fkea.git [#28,!20] Fixed doxygen warnings in DHCP config backend classes. --- diff --git a/src/lib/dhcpsrv/config_backend_dhcp4.h b/src/lib/dhcpsrv/config_backend_dhcp4.h index 9e19b01a5c..c6324846ce 100644 --- a/src/lib/dhcpsrv/config_backend_dhcp4.h +++ b/src/lib/dhcpsrv/config_backend_dhcp4.h @@ -81,7 +81,7 @@ public: /// @brief Retrieves shared networks modified after specified time. /// /// @param selector Server selector. - /// @param Lower bound shared network modification time. + /// @param modification_time Lower bound shared network modification time. /// @return Collection of shared network or empty collection if /// no shared network found. virtual SharedNetwork4Collection @@ -176,9 +176,11 @@ public: /// /// @param selector Server selector. /// @param subnet_id Identifier of a subnet to which option belongs. + /// @param option Option to be added or updated. virtual void createUpdateOption4(const db::ServerSelector& selector, - const SubnetID& subnet_id, const OptionPtr& option) = 0; + const SubnetID& subnet_id, + const OptionPtr& option) = 0; /// @brief Creates or updates pool level option. /// @@ -187,6 +189,7 @@ public: /// the option belongs. /// @param pool_end_address Upper bound address of the pool to which the /// option belongs. + /// @param option Option to be added or updated. virtual void createUpdateOption4(const db::ServerSelector& selector, const asiolink::IOAddress& pool_start_address, @@ -288,8 +291,10 @@ public: /// @param selector Server selector. /// @param pool_start_address Lower bound address of the pool to which /// deleted option belongs. - /// @param pool_end_start Upper bound address of the pool to which the + /// @param pool_end_address Upper bound address of the pool to which the /// deleted option belongs. + /// @param code Code of the deleted option. + /// @param space Option space of the deleted option. virtual void deleteOption4(const db::ServerSelector& selector, const asiolink::IOAddress& pool_start_address, diff --git a/src/lib/dhcpsrv/config_backend_pool_dhcp4.cc b/src/lib/dhcpsrv/config_backend_pool_dhcp4.cc index 9b01e6b947..d378273781 100644 --- a/src/lib/dhcpsrv/config_backend_pool_dhcp4.cc +++ b/src/lib/dhcpsrv/config_backend_pool_dhcp4.cc @@ -15,8 +15,8 @@ namespace isc { namespace dhcp { Subnet4Ptr -ConfigBackendPoolDHCPv4::getSubnet4(const BackendSelector& backend_selector, - const ServerSelector& server_selector, +ConfigBackendPoolDHCPv4::getSubnet4(const db::BackendSelector& backend_selector, + const db::ServerSelector& server_selector, const std::string& subnet_prefix) const { Subnet4Ptr subnet; getPropertyPtrConst @@ -26,8 +26,8 @@ ConfigBackendPoolDHCPv4::getSubnet4(const BackendSelector& backend_selector, } Subnet4Ptr -ConfigBackendPoolDHCPv4::getSubnet4(const BackendSelector& backend_selector, - const ServerSelector& server_selector, +ConfigBackendPoolDHCPv4::getSubnet4(const db::BackendSelector& backend_selector, + const db::ServerSelector& server_selector, const SubnetID& subnet_id) const { Subnet4Ptr subnet; getPropertyPtrConst @@ -37,8 +37,8 @@ ConfigBackendPoolDHCPv4::getSubnet4(const BackendSelector& backend_selector, } Subnet4Collection -ConfigBackendPoolDHCPv4::getAllSubnets4(const BackendSelector& backend_selector, - const ServerSelector& server_selector) const { +ConfigBackendPoolDHCPv4::getAllSubnets4(const db::BackendSelector& backend_selector, + const db::ServerSelector& server_selector) const { Subnet4Collection subnets; getAllPropertiesConst (&ConfigBackendDHCPv4::getAllSubnets4, backend_selector, server_selector, @@ -47,8 +47,8 @@ ConfigBackendPoolDHCPv4::getAllSubnets4(const BackendSelector& backend_selector, } Subnet4Collection -ConfigBackendPoolDHCPv4::getModifiedSubnets4(const BackendSelector& backend_selector, - const ServerSelector& server_selector, +ConfigBackendPoolDHCPv4::getModifiedSubnets4(const db::BackendSelector& backend_selector, + const db::ServerSelector& server_selector, const boost::posix_time::ptime& modification_time) const { Subnet4Collection subnets; getMultiplePropertiesConst @@ -58,8 +58,8 @@ ConfigBackendPoolDHCPv4::getModifiedSubnets4(const BackendSelector& backend_sele } SharedNetwork4Ptr -ConfigBackendPoolDHCPv4::getSharedNetwork4(const BackendSelector& backend_selector, - const ServerSelector& server_selector, +ConfigBackendPoolDHCPv4::getSharedNetwork4(const db::BackendSelector& backend_selector, + const db::ServerSelector& server_selector, const std::string& name) const { SharedNetwork4Ptr shared_network; getPropertyPtrConst @@ -69,8 +69,8 @@ ConfigBackendPoolDHCPv4::getSharedNetwork4(const BackendSelector& backend_select } SharedNetwork4Collection -ConfigBackendPoolDHCPv4::getAllSharedNetworks4(const BackendSelector& backend_selector, - const ServerSelector& server_selector) const { +ConfigBackendPoolDHCPv4::getAllSharedNetworks4(const db::BackendSelector& backend_selector, + const db::ServerSelector& server_selector) const { SharedNetwork4Collection shared_networks; getAllPropertiesConst (&ConfigBackendDHCPv4::getAllSharedNetworks4, backend_selector, server_selector, @@ -80,8 +80,8 @@ ConfigBackendPoolDHCPv4::getAllSharedNetworks4(const BackendSelector& backend_se SharedNetwork4Collection ConfigBackendPoolDHCPv4:: -getModifiedSharedNetworks4(const BackendSelector& backend_selector, - const ServerSelector& server_selector, +getModifiedSharedNetworks4(const db::BackendSelector& backend_selector, + const db::ServerSelector& server_selector, const boost::posix_time::ptime& modification_time) const { SharedNetwork4Collection shared_networks; getMultiplePropertiesConst @@ -91,8 +91,8 @@ getModifiedSharedNetworks4(const BackendSelector& backend_selector, } OptionDefinitionPtr -ConfigBackendPoolDHCPv4::getOptionDef4(const BackendSelector& backend_selector, - const ServerSelector& server_selector, +ConfigBackendPoolDHCPv4::getOptionDef4(const db::BackendSelector& backend_selector, + const db::ServerSelector& server_selector, const uint16_t code, const std::string& space) const { OptionDefinitionPtr option_def; @@ -103,8 +103,8 @@ ConfigBackendPoolDHCPv4::getOptionDef4(const BackendSelector& backend_selector, } OptionDefContainer -ConfigBackendPoolDHCPv4::getAllOptionDefs4(const BackendSelector& backend_selector, - const ServerSelector& server_selector) const { +ConfigBackendPoolDHCPv4::getAllOptionDefs4(const db::BackendSelector& backend_selector, + const db::ServerSelector& server_selector) const { OptionDefContainer option_defs; getAllPropertiesConst (&ConfigBackendDHCPv4::getAllOptionDefs4, backend_selector, server_selector, @@ -113,8 +113,8 @@ ConfigBackendPoolDHCPv4::getAllOptionDefs4(const BackendSelector& backend_select } OptionDefContainer -ConfigBackendPoolDHCPv4::getModifiedOptionDefs4(const BackendSelector& backend_selector, - const ServerSelector& server_selector, +ConfigBackendPoolDHCPv4::getModifiedOptionDefs4(const db::BackendSelector& backend_selector, + const db::ServerSelector& server_selector, const boost::posix_time::ptime& modification_time) const { OptionDefContainer option_defs; getMultiplePropertiesConst @@ -124,8 +124,8 @@ ConfigBackendPoolDHCPv4::getModifiedOptionDefs4(const BackendSelector& backend_s } util::OptionalValue -ConfigBackendPoolDHCPv4::getGlobalStringParameter4(const BackendSelector& backend_selector, - const ServerSelector& server_selector, +ConfigBackendPoolDHCPv4::getGlobalStringParameter4(const db::BackendSelector& backend_selector, + const db::ServerSelector& server_selector, const std::string& name) const { OptionalValue parameter; getOptionalPropertyConst @@ -135,8 +135,8 @@ ConfigBackendPoolDHCPv4::getGlobalStringParameter4(const BackendSelector& backen } util::OptionalValue -ConfigBackendPoolDHCPv4::getGlobalNumberParameter4(const BackendSelector& backend_selector, - const ServerSelector& server_selector, +ConfigBackendPoolDHCPv4::getGlobalNumberParameter4(const db::BackendSelector& backend_selector, + const db::ServerSelector& server_selector, const std::string& name) const { OptionalValue parameter; getOptionalPropertyConst @@ -146,8 +146,8 @@ ConfigBackendPoolDHCPv4::getGlobalNumberParameter4(const BackendSelector& backen } std::map -ConfigBackendPoolDHCPv4::getAllGlobalParameters4(const BackendSelector& backend_selector, - const ServerSelector& server_selector) const { +ConfigBackendPoolDHCPv4::getAllGlobalParameters4(const db::BackendSelector& backend_selector, + const db::ServerSelector& server_selector) const { std::map parameters; getAllPropertiesConst > (&ConfigBackendDHCPv4::getAllGlobalParameters4, backend_selector, @@ -156,8 +156,8 @@ ConfigBackendPoolDHCPv4::getAllGlobalParameters4(const BackendSelector& backend_ } void -ConfigBackendPoolDHCPv4::createUpdateSubnet4(const BackendSelector& backend_selector, - const ServerSelector& server_selector, +ConfigBackendPoolDHCPv4::createUpdateSubnet4(const db::BackendSelector& backend_selector, + const db::ServerSelector& server_selector, const Subnet4Ptr& subnet) { createUpdateDeleteProperty (&ConfigBackendDHCPv4::createUpdateSubnet4, backend_selector, @@ -165,8 +165,8 @@ ConfigBackendPoolDHCPv4::createUpdateSubnet4(const BackendSelector& backend_sele } void -ConfigBackendPoolDHCPv4::createUpdateSharedNetwork4(const BackendSelector& backend_selector, - const ServerSelector& server_selector, +ConfigBackendPoolDHCPv4::createUpdateSharedNetwork4(const db::BackendSelector& backend_selector, + const db::ServerSelector& server_selector, const SharedNetwork4Ptr& shared_network) { createUpdateDeleteProperty (&ConfigBackendDHCPv4::createUpdateSharedNetwork4, backend_selector, @@ -174,8 +174,8 @@ ConfigBackendPoolDHCPv4::createUpdateSharedNetwork4(const BackendSelector& backe } void -ConfigBackendPoolDHCPv4::createUpdateOptionDef4(const BackendSelector& backend_selector, - const ServerSelector& server_selector, +ConfigBackendPoolDHCPv4::createUpdateOptionDef4(const db::BackendSelector& backend_selector, + const db::ServerSelector& server_selector, const OptionDefinitionPtr& option_def) { createUpdateDeleteProperty (&ConfigBackendDHCPv4::createUpdateOptionDef4, backend_selector, @@ -183,8 +183,8 @@ ConfigBackendPoolDHCPv4::createUpdateOptionDef4(const BackendSelector& backend_s } void -ConfigBackendPoolDHCPv4::createUpdateOption4(const BackendSelector& backend_selector, - const ServerSelector& server_selector, +ConfigBackendPoolDHCPv4::createUpdateOption4(const db::BackendSelector& backend_selector, + const db::ServerSelector& server_selector, const OptionPtr& option) { createUpdateDeleteProperty (&ConfigBackendDHCPv4::createUpdateOption4, backend_selector, @@ -192,8 +192,8 @@ ConfigBackendPoolDHCPv4::createUpdateOption4(const BackendSelector& backend_sele } void -ConfigBackendPoolDHCPv4::createUpdateOption4(const BackendSelector& backend_selector, - const ServerSelector& server_selector, +ConfigBackendPoolDHCPv4::createUpdateOption4(const db::BackendSelector& backend_selector, + const db::ServerSelector& server_selector, const SubnetID& subnet_id, const OptionPtr& option) { createUpdateDeleteProperty @@ -202,8 +202,8 @@ ConfigBackendPoolDHCPv4::createUpdateOption4(const BackendSelector& backend_sele } void -ConfigBackendPoolDHCPv4::createUpdateOption4(const BackendSelector& backend_selector, - const ServerSelector& server_selector, +ConfigBackendPoolDHCPv4::createUpdateOption4(const db::BackendSelector& backend_selector, + const db::ServerSelector& server_selector, const IOAddress& pool_start_address, const IOAddress& pool_end_address, const OptionPtr& option) { @@ -213,8 +213,8 @@ ConfigBackendPoolDHCPv4::createUpdateOption4(const BackendSelector& backend_sele } void -ConfigBackendPoolDHCPv4::createUpdateGlobalParameter4(const BackendSelector& backend_selector, - const ServerSelector& server_selector, +ConfigBackendPoolDHCPv4::createUpdateGlobalParameter4(const db::BackendSelector& backend_selector, + const db::ServerSelector& server_selector, const std::string& name, const std::string& value) { createUpdateDeleteProperty @@ -223,8 +223,8 @@ ConfigBackendPoolDHCPv4::createUpdateGlobalParameter4(const BackendSelector& bac } void -ConfigBackendPoolDHCPv4::createUpdateGlobalParameter4(const BackendSelector& backend_selector, - const ServerSelector& server_selector, +ConfigBackendPoolDHCPv4::createUpdateGlobalParameter4(const db::BackendSelector& backend_selector, + const db::ServerSelector& server_selector, const std::string& name, const int64_t value) { createUpdateDeleteProperty @@ -233,8 +233,8 @@ ConfigBackendPoolDHCPv4::createUpdateGlobalParameter4(const BackendSelector& bac } void -ConfigBackendPoolDHCPv4::deleteSubnet4(const BackendSelector& backend_selector, - const ServerSelector& server_selector, +ConfigBackendPoolDHCPv4::deleteSubnet4(const db::BackendSelector& backend_selector, + const db::ServerSelector& server_selector, const std::string& subnet_prefix) { createUpdateDeleteProperty (&ConfigBackendDHCPv4::deleteSubnet4, backend_selector, server_selector, @@ -242,8 +242,8 @@ ConfigBackendPoolDHCPv4::deleteSubnet4(const BackendSelector& backend_selector, } void -ConfigBackendPoolDHCPv4::deleteSubnet4(const BackendSelector& backend_selector, - const ServerSelector& server_selector, +ConfigBackendPoolDHCPv4::deleteSubnet4(const db::BackendSelector& backend_selector, + const db::ServerSelector& server_selector, const SubnetID& subnet_id) { createUpdateDeleteProperty (&ConfigBackendDHCPv4::deleteSubnet4, backend_selector, server_selector, @@ -251,15 +251,15 @@ ConfigBackendPoolDHCPv4::deleteSubnet4(const BackendSelector& backend_selector, } void -ConfigBackendPoolDHCPv4::deleteAllSubnets4(const BackendSelector& backend_selector, - const ServerSelector& server_selector) { +ConfigBackendPoolDHCPv4::deleteAllSubnets4(const db::BackendSelector& backend_selector, + const db::ServerSelector& server_selector) { createUpdateDeleteProperty<> (&ConfigBackendDHCPv4::deleteAllSubnets4, backend_selector, server_selector); } void -ConfigBackendPoolDHCPv4::deleteSharedNetwork4(const BackendSelector& backend_selector, - const ServerSelector& server_selector, +ConfigBackendPoolDHCPv4::deleteSharedNetwork4(const db::BackendSelector& backend_selector, + const db::ServerSelector& server_selector, const std::string& name) { createUpdateDeleteProperty (&ConfigBackendDHCPv4::deleteSharedNetwork4, backend_selector, @@ -267,15 +267,15 @@ ConfigBackendPoolDHCPv4::deleteSharedNetwork4(const BackendSelector& backend_sel } void -ConfigBackendPoolDHCPv4::deleteAllSharedNetworks4(const BackendSelector& backend_selector, - const ServerSelector& server_selector) { +ConfigBackendPoolDHCPv4::deleteAllSharedNetworks4(const db::BackendSelector& backend_selector, + const db::ServerSelector& server_selector) { createUpdateDeleteProperty<> (&ConfigBackendDHCPv4::deleteAllSharedNetworks4, backend_selector, server_selector); } void -ConfigBackendPoolDHCPv4::deleteOptionDef4(const BackendSelector& backend_selector, - const ServerSelector& server_selector, +ConfigBackendPoolDHCPv4::deleteOptionDef4(const db::BackendSelector& backend_selector, + const db::ServerSelector& server_selector, const uint16_t code, const std::string& space) { createUpdateDeleteProperty @@ -284,15 +284,15 @@ ConfigBackendPoolDHCPv4::deleteOptionDef4(const BackendSelector& backend_selecto } void -ConfigBackendPoolDHCPv4::deleteAllOptionDefs4(const BackendSelector& backend_selector, - const ServerSelector& server_selector) { +ConfigBackendPoolDHCPv4::deleteAllOptionDefs4(const db::BackendSelector& backend_selector, + const db::ServerSelector& server_selector) { createUpdateDeleteProperty<> (&ConfigBackendDHCPv4::deleteAllOptionDefs4, backend_selector, server_selector); } void -ConfigBackendPoolDHCPv4::deleteOption4(const BackendSelector& backend_selector, - const ServerSelector& server_selector, +ConfigBackendPoolDHCPv4::deleteOption4(const db::BackendSelector& backend_selector, + const db::ServerSelector& server_selector, const uint16_t code, const std::string& space) { createUpdateDeleteProperty @@ -301,8 +301,8 @@ ConfigBackendPoolDHCPv4::deleteOption4(const BackendSelector& backend_selector, } void -ConfigBackendPoolDHCPv4::deleteOption4(const BackendSelector& backend_selector, - const ServerSelector& server_selector, +ConfigBackendPoolDHCPv4::deleteOption4(const db::BackendSelector& backend_selector, + const db::ServerSelector& server_selector, const SubnetID& subnet_id, const uint16_t code, const std::string& space) { @@ -312,8 +312,8 @@ ConfigBackendPoolDHCPv4::deleteOption4(const BackendSelector& backend_selector, } void -ConfigBackendPoolDHCPv4::deleteOption4(const BackendSelector& backend_selector, - const ServerSelector& server_selector, +ConfigBackendPoolDHCPv4::deleteOption4(const db::BackendSelector& backend_selector, + const db::ServerSelector& server_selector, const asiolink::IOAddress& pool_start_address, const asiolink::IOAddress& pool_end_address, const uint16_t code, @@ -325,8 +325,8 @@ ConfigBackendPoolDHCPv4::deleteOption4(const BackendSelector& backend_selector, } void -ConfigBackendPoolDHCPv4::deleteGlobalParameter4(const BackendSelector& backend_selector, - const ServerSelector& server_selector, +ConfigBackendPoolDHCPv4::deleteGlobalParameter4(const db::BackendSelector& backend_selector, + const db::ServerSelector& server_selector, const std::string& name) { createUpdateDeleteProperty (&ConfigBackendDHCPv4::deleteGlobalParameter4, backend_selector, @@ -334,8 +334,8 @@ ConfigBackendPoolDHCPv4::deleteGlobalParameter4(const BackendSelector& backend_s } void -ConfigBackendPoolDHCPv4::deleteAllGlobalParameters4(const BackendSelector& backend_selector, - const ServerSelector& server_selector) { +ConfigBackendPoolDHCPv4::deleteAllGlobalParameters4(const db::BackendSelector& backend_selector, + const db::ServerSelector& server_selector) { createUpdateDeleteProperty<> (&ConfigBackendDHCPv4::deleteAllGlobalParameters4, backend_selector, server_selector); diff --git a/src/lib/dhcpsrv/config_backend_pool_dhcp4.h b/src/lib/dhcpsrv/config_backend_pool_dhcp4.h index 75e962a278..271e5cc462 100644 --- a/src/lib/dhcpsrv/config_backend_pool_dhcp4.h +++ b/src/lib/dhcpsrv/config_backend_pool_dhcp4.h @@ -93,7 +93,7 @@ public: /// /// @param backend_selector Backend selector. /// @param server_selector Server selector. - /// @param Lower bound shared network modification time. + /// @param modification_time Lower bound shared network modification time. /// @return Collection of shared network or empty collection if /// no shared network found. virtual SharedNetwork4Collection @@ -211,10 +211,12 @@ public: /// @param backend_selector Backend selector. /// @param server_selector Server selector. /// @param subnet_id Identifier of a subnet to which option belongs. + /// @param option Option to be added or updated. virtual void createUpdateOption4(const db::BackendSelector& backend_selector, const db::ServerSelector& server_selector, - const SubnetID& subnet_id, const OptionPtr& option); + const SubnetID& subnet_id, + const OptionPtr& option); /// @brief Creates or updates pool level option. /// @@ -224,6 +226,7 @@ public: /// the option belongs. /// @param pool_end_address Upper bound address of the pool to which the /// option belongs. + /// @param option Option to be added or updated. virtual void createUpdateOption4(const db::BackendSelector& backend_selector, const db::ServerSelector& server_selector, @@ -353,8 +356,10 @@ public: /// @param server_selector Server selector. /// @param pool_start_address Lower bound address of the pool to which /// deleted option belongs. - /// @param pool_end_start Upper bound address of the pool to which the + /// @param pool_end_address Upper bound address of the pool to which the /// deleted option belongs. + /// @param code Code of the deleted option. + /// @param space Option space of the deleted option. virtual void deleteOption4(const db::BackendSelector& backend_selector, const db::ServerSelector& server_selector,