BIND 10 trac2432, updated. 806865cd2e830785f0d377d759e7475b9e1f640b [2432] Fix more cases of \return (use singular form)
BIND 10 source code commits
bind10-changes at lists.isc.org
Mon Jan 7 09:44:39 UTC 2013
The branch, trac2432 has been updated
via 806865cd2e830785f0d377d759e7475b9e1f640b (commit)
from e7f9ab53656fdfb8a1b27c7056f8dc2c86d8f966 (commit)
Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.
- Log -----------------------------------------------------------------
commit 806865cd2e830785f0d377d759e7475b9e1f640b
Author: Mukund Sivaraman <muks at isc.org>
Date: Mon Jan 7 15:09:27 2013 +0530
[2432] Fix more cases of \return (use singular form)
-----------------------------------------------------------------------
Summary of changes:
src/bin/resolver/resolver.h | 6 +++---
src/lib/cc/data.h | 3 +--
src/lib/config/config_data.h | 4 ++--
3 files changed, 6 insertions(+), 7 deletions(-)
-----------------------------------------------------------------------
diff --git a/src/bin/resolver/resolver.h b/src/bin/resolver/resolver.h
index cc0f09f..725aa85 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 bb84ae2..db25d9f 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 0bb1bfd..1be7c7a 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
More information about the bind10-changes
mailing list