]> git.ipfire.org Git - thirdparty/kea.git/commitdiff
[#3477] Typos (Razvan's proposals)
authorFrancis Dupont <fdupont@isc.org>
Tue, 23 Jul 2024 13:11:02 +0000 (15:11 +0200)
committerFrancis Dupont <fdupont@isc.org>
Thu, 1 Aug 2024 07:23:54 +0000 (09:23 +0200)
src/lib/config/http_command_config.cc
src/lib/config/http_command_config.h
src/lib/config/http_command_mgr.cc
src/lib/config/http_command_mgr.h
src/lib/config/http_command_response_creator.cc
src/lib/d2srv/d2_cfg_mgr.h
src/lib/dhcpsrv/srv_config.h

index ecb1f3d326d53f4ce0f104d76870a7d545e593eb..e9af0586642d1ba6fa9abccf70a1d21144677709 100644 (file)
@@ -171,7 +171,7 @@ HttpCommandConfig::HttpCommandConfig(ConstElementPtr config)
         cert_required_ = cert_required->boolValue();
     }
 
-    // Check the TLS settup.
+    // Check the TLS setup.
     checkTlsSetup(socket_type_ == "https");
 
     // Get user context.
index 30b9c5c5c00be3e54d5cfb914de572327afe8560..b1eef16083c3f326d517068d2fd5c384182fe59a 100644 (file)
@@ -146,7 +146,7 @@ public:
 
     /// @brief Returns emulate agent response flag.
     ///
-    /// @return True when responses for normal ommand outcomes are
+    /// @return True when responses for normal command outcomes are
     /// guaranteed to be wrapped in an Element::list. This emulates
     /// how kea-ctrl-agent forms responses. Defaults to true.
     bool getEmulateAgentResponse() const {
index fca44b27238c733cbedded10fe5dde1c709703ac..1d860c68e75988591e421d78e23e46720a7957fa 100644 (file)
@@ -102,7 +102,6 @@ HttpCommandMgrImpl::configure(HttpCommandConfigPtr config) {
     }
 
     // Last case: from no config, or address or port change.
-    /////
     current_config_ = config;
     IOAddress server_address = config->getSocketAddress();
     uint16_t server_port = config->getSocketPort();
index fb66c1a9e61d67b15cfa9a50aeea18d7962dfae1..ec4356eaaf50d9ac2c70779f89a3a846e4e7ab18 100644 (file)
@@ -74,7 +74,7 @@ public:
     /// @brief Returns a const pointer to the HTTP listener.
     ///
     /// @return Const pointer to the currently used listener or null pointer if
-    /// we're not listening.
+    /// there is no listener.
     isc::http::ConstHttpListenerPtr getHttpListener() const;
 
 private:
index 8cd71900bdf18af5c31f2bde7b46377fca16ea81..a2953f3d584221cd9e18fd0e34d0ab95cfa53a2a 100644 (file)
@@ -32,7 +32,7 @@ struct HttpCommandHooks {
 
     /// Constructor that registers hook points.
     HttpCommandHooks() {
-        hook_index_http_auth_  = HooksManager::registerHook("http_auth");
+        hook_index_http_auth_ = HooksManager::registerHook("http_auth");
         hook_index_http_response_ = HooksManager::registerHook("http_response");
     }
 };
@@ -156,7 +156,7 @@ HttpCommandResponseCreator::createDynamicHttpResponse(HttpRequestPtr request) {
         return (createStockHttpResponse(request, HttpStatusCode::INTERNAL_SERVER_ERROR));
     }
 
-    // Normal Responses coming from the Kea Control Agent must always be wrapped in
+    // Normal Responses coming from the Kea server must always be wrapped in
     // a list as they may contain responses from multiple daemons.
     // If we're emulating that for backward compatibility, then we need to wrap
     // the answer in a list if it isn't in one already.
index 49838e03cd928c6f9ceff89a7bb1233a42b9cd55..81df26ab2ec9c9dbaaee63ff8825e95b64c65881 100644 (file)
@@ -60,6 +60,7 @@ public:
     }
 
     /// @brief Sets the forward domain list manager
+    ///
     /// @param forward_mgr pointer to the new forward manager
     void setForwardMgr(DdnsDomainListMgrPtr forward_mgr) {
         forward_mgr_ = forward_mgr;
@@ -73,6 +74,7 @@ public:
     }
 
     /// @brief Sets the reverse domain list manager
+    ///
     /// @param reverse_mgr pointer to the new reverse manager
     void setReverseMgr(DdnsDomainListMgrPtr reverse_mgr) {
         reverse_mgr_ = reverse_mgr;
@@ -93,25 +95,29 @@ public:
     }
 
     /// @brief Returns information about UNIX control socket
-    /// @return pointer to the Element that holds control-socket map
+    ///
+    /// @return pointer to the UNIX control socket config
     const isc::data::ConstElementPtr getControlSocketInfo() const {
         return (unix_control_socket_);
     }
 
     /// @brief Sets information about the UNIX control socket
-    /// @param control_socket Element that holds control-socket map
+    ///
+    /// @param ontrol_socket UNIX control socket config
     void setControlSocketInfo(const isc::data::ConstElementPtr& control_socket) {
         unix_control_socket_ = control_socket;
     }
 
     /// @brief Returns information about HTTP/HTTPS control socket
+    ///
     /// @return pointer to the HTTP/HTTPS control socket config
     isc::config::HttpCommandConfigPtr getHttpControlSocketInfo() const {
         return (http_control_socket_);
     }
 
     /// @brief Sets information about the HTTP/HTTPS control socket
-    /// @param control_socket HTTP/HTTPScontrol socket config
+    ///
+    /// @param control_socket HTTP/HTTPS control socket config
     void setHttpControlSocketInfo(const isc::config::HttpCommandConfigPtr& control_socket) {
         http_control_socket_ = control_socket;
     }
@@ -155,10 +161,10 @@ private:
     /// @brief Storage for the map of TSIGKeyInfos.
     TSIGKeyInfoMapPtr keys_;
 
-    /// @brief Pointer to the UNIX control-socket information.
+    /// @brief Pointer to the UNIX control socket configuration.
     isc::data::ConstElementPtr unix_control_socket_;
 
-    /// @brief Pointer to the HTTP/HTTPS control socket configuration
+    /// @brief Pointer to the HTTP/HTTPS control socket configuration.
     isc::config::HttpCommandConfigPtr http_control_socket_;
 
     /// @brief Configured hooks libraries.
@@ -177,10 +183,12 @@ typedef boost::shared_ptr<DdnsDomainListMgr> DdnsDomainListMgrPtr;
 class D2CfgMgr : public process::DCfgMgrBase {
 public:
     /// @brief Reverse zone suffix added to IPv4 addresses for reverse lookups
+    ///
     /// @todo This should be configurable.
     static const char* IPV4_REV_ZONE_SUFFIX;
 
     /// @brief Reverse zone suffix added to IPv6 addresses for reverse lookups
+    ///
     /// @todo This should be configurable.
     static const char* IPV6_REV_ZONE_SUFFIX;
 
@@ -298,16 +306,19 @@ public:
     static std::string reverseV6Address(const isc::asiolink::IOAddress& ioaddr);
 
     /// @brief Convenience method fetches the D2Params from context
+    ///
     /// @return reference to const D2ParamsPtr
     const D2ParamsPtr& getD2Params();
 
     /// @brief Convenience method fetches information about
     /// UNIX control socket from context
+    ///
     /// @return pointer to the Element that holds control-socket map
     const isc::data::ConstElementPtr getControlSocketInfo();
 
     /// @brief Convenience method fetches information about
     /// HTTP/HTTPS control socket from context
+    ///
     /// @return pointer to the HTTP/HTTPS control socket config
     isc::config::HttpCommandConfigPtr getHttpControlSocketInfo();
 
@@ -327,6 +338,7 @@ protected:
     /// @param config Pointer to a configuration specified for D2.
     /// @param check_only Boolean flag indicating if this method should
     /// only verify correctness of the provided configuration.
+    ///
     /// @return Pointer to a result of configuration parsing.
     virtual isc::data::ConstElementPtr
     parse(isc::data::ConstElementPtr config, bool check_only) override;
index 50195a7bdb6fb100263eaf903f52814f402947d7..5a6fc78a70f9d60993180629aba263bbe5f6997b 100644 (file)
@@ -533,14 +533,14 @@ public:
 
     /// @brief Returns information about UNIX control socket
     ///
-    /// @return pointer to the Element that holds control-socket map
+    /// @return pointer to the UNIX control socket config
     const isc::data::ConstElementPtr getControlSocketInfo() const {
         return (unix_control_socket_);
     }
 
     /// @brief Sets information about the UNIX control socket
     ///
-    /// @param control_socket Element that holds control-socket map
+    /// @param control_socket UNIX control socket config
     void setControlSocketInfo(const isc::data::ConstElementPtr& control_socket) {
         unix_control_socket_ = control_socket;
     }
@@ -554,7 +554,7 @@ public:
 
     /// @brief Sets information about the HTTP/HTTPS control socket
     ///
-    /// @param control_socket HTTP/HTTPScontrol socket config
+    /// @param control_socket HTTP/HTTPS control socket config
     void setHttpControlSocketInfo(const isc::config::HttpCommandConfigPtr& control_socket) {
         http_control_socket_ = control_socket;
     }
@@ -1191,7 +1191,7 @@ private:
     /// DHCPv6.
     CfgHostOperationsPtr cfg_host_operations6_;
 
-    /// @brief Pointer to the UNIX control-socket information
+    /// @brief Pointer to the UNIX control socket configuration
     isc::data::ConstElementPtr unix_control_socket_;
 
     /// @brief Pointer to the HTTP/HTTPS control socket configuration