]> git.ipfire.org Git - thirdparty/kea.git/commitdiff
[2432] Fix more cases of \return (use singular form)
authorMukund Sivaraman <muks@isc.org>
Mon, 7 Jan 2013 09:39:27 +0000 (15:09 +0530)
committerJINMEI Tatuya <jinmei@isc.org>
Mon, 7 Jan 2013 23:10:45 +0000 (15:10 -0800)
src/bin/resolver/resolver.h
src/lib/cc/data.h
src/lib/config/config_data.h

index cc0f09f9bfbf1ac30e635f3c5e596786afac9cb6..725aa854d85071b07086051ff35c630dfe1d6d4c 100644 (file)
@@ -200,14 +200,14 @@ public:
     /**
      * \short Get info about timeouts.
      *
-     * \returns Timeout and retries (as described in setTimeouts).
+     * \return Timeout and retries (as described in setTimeouts).
      */
     std::pair<int, unsigned> getTimeouts() const;
 
     /**
      * \brief Get the timeout for outgoing queries
      *
-     * \returns Timeout for outgoing queries
+     * \return Timeout for outgoing queries
      */
     int getQueryTimeout() const;
 
@@ -218,7 +218,7 @@ public:
      * (internal resolving on the query will continue, see
      * \c getLookupTimeout())
      * 
-     * \returns Timeout for outgoing queries
+     * \return Timeout for outgoing queries
      */
     int getClientTimeout() const;
 
index bb84ae2e30396afb223bf92db0bf41cc4b538d3f..db25d9fb3c120dc3b4f7068af48012ed291a13a3 100644 (file)
@@ -109,8 +109,7 @@ public:
 
     /// \name pure virtuals, every derived class must implement these
 
-    /// \returns true if the other ElementPtr has the same type and
-    ///          value
+    /// \return true if the other ElementPtr has the same type and value
     virtual bool equals(const Element& other) const = 0;
 
     /// Converts the Element to JSON format and appends it to
index 0bb1bfdb7c2982bbfe38c474e141029e6f507534..1be7c7a4bb7a9f4cc30319a16f65c01f5144bfd0 100644 (file)
@@ -93,8 +93,8 @@ public:
     void setLocalConfig(isc::data::ElementPtr config) { _config = config; }
 
     /// Returns the local (i.e. non-default) configuration.
-    /// \returns An ElementPtr pointing to a MapElement containing all
-    ///          non-default configuration options.
+    /// \return An ElementPtr pointing to a MapElement containing all
+    ///         non-default configuration options.
     isc::data::ElementPtr getLocalConfig() { return (_config); }
 
     /// Returns a list of all possible configuration options as specified