2
0
mirror of https://gitlab.isc.org/isc-projects/kea synced 2025-08-29 13:07:50 +00:00

[#2011] clean up comments

This commit is contained in:
Razvan Becheriu 2021-08-09 18:01:22 +03:00 committed by Francis Dupont
parent 4559fb4e63
commit e8ebf11fb1

View File

@ -490,7 +490,7 @@ public:
/// @brief Convenience method which returns the server's TSIG key name. /// @brief Convenience method which returns the server's TSIG key name.
/// ///
/// @return the key name in an std::string. If server has no TSIG key, /// @return the key name in a std::string. If server has no TSIG key,
/// the string will be empty. /// the string will be empty.
const std::string getKeyName() const; const std::string getKeyName() const;
@ -526,7 +526,7 @@ private:
/// enabled for use. It defaults to true. /// enabled for use. It defaults to true.
bool enabled_; bool enabled_;
/// @brief Pointer to the server TSIGKeyInfo.. /// @brief Pointer to the server TSIGKeyInfo.
/// Value is empty if the server is not configured for TSIG. /// Value is empty if the server is not configured for TSIG.
TSIGKeyInfoPtr tsig_key_info_; TSIGKeyInfoPtr tsig_key_info_;
@ -552,7 +552,7 @@ typedef boost::shared_ptr<DnsServerInfoStorage> DnsServerInfoStoragePtr;
/// This class specifies a DNS domain and the list of DNS servers that support /// This class specifies a DNS domain and the list of DNS servers that support
/// it. Its primary use is to map a domain to the DNS server(s) responsible /// it. Its primary use is to map a domain to the DNS server(s) responsible
/// for it. /// for it.
/// @todo Currently the name entry for a domain is just an std::string. It /// @todo Currently the name entry for a domain is just a std::string. It
/// may be worthwhile to change this to a dns::Name for purposes of better /// may be worthwhile to change this to a dns::Name for purposes of better
/// validation and matching capabilities. /// validation and matching capabilities.
class DdnsDomain : public isc::data::UserContext, public isc::data::CfgToElement { class DdnsDomain : public isc::data::UserContext, public isc::data::CfgToElement {
@ -570,7 +570,7 @@ public:
/// @brief Getter which returns the domain's name. /// @brief Getter which returns the domain's name.
/// ///
/// @return returns the name in an std::string. /// @return returns the name in a std::string.
const std::string getName() const { const std::string getName() const {
return (name_); return (name_);
} }
@ -579,7 +579,7 @@ public:
/// ///
/// @note: TSIG key infos are in servers. /// @note: TSIG key infos are in servers.
/// ///
/// @return returns the key name in an std::string. If domain has no /// @return returns the key name in a std::string. If domain has no
/// TSIG key, the string will be empty. /// TSIG key, the string will be empty.
const std::string getKeyName() const { const std::string getKeyName() const {
return (key_name_); return (key_name_);