From: Mukund Sivaraman <muks@isc.org>
Date: Mon, 7 Jan 2013 09:39:27 +0000 (+0530)
Subject: [2432] Fix more cases of \return (use singular form)
X-Git-Tag: bind10-1.0.0-rc-release~76^2~21^2~3^2^2~11^2~22
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=a2e1d3f2d9f4bd9680932a46cf2b00c1cd2a1a64;p=thirdparty%2Fkea.git

[2432] Fix more cases of \return (use singular form)
---

diff --git a/src/bin/resolver/resolver.h b/src/bin/resolver/resolver.h
index cc0f09f9bf..725aa854d8 100644
--- a/src/bin/resolver/resolver.h
+++ b/src/bin/resolver/resolver.h
@@ -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;
 
diff --git a/src/lib/cc/data.h b/src/lib/cc/data.h
index bb84ae2e30..db25d9fb3c 100644
--- a/src/lib/cc/data.h
+++ b/src/lib/cc/data.h
@@ -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
diff --git a/src/lib/config/config_data.h b/src/lib/config/config_data.h
index 0bb1bfdb7c..1be7c7a4bb 100644
--- a/src/lib/config/config_data.h
+++ b/src/lib/config/config_data.h
@@ -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