Commit 806865cd authored by Mukund Sivaraman's avatar Mukund Sivaraman
Browse files

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

parent e7f9ab53
...@@ -200,14 +200,14 @@ public: ...@@ -200,14 +200,14 @@ public:
/** /**
* \short Get info about timeouts. * \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; std::pair<int, unsigned> getTimeouts() const;
/** /**
* \brief Get the timeout for outgoing queries * \brief Get the timeout for outgoing queries
* *
* \returns Timeout for outgoing queries * \return Timeout for outgoing queries
*/ */
int getQueryTimeout() const; int getQueryTimeout() const;
...@@ -218,7 +218,7 @@ public: ...@@ -218,7 +218,7 @@ public:
* (internal resolving on the query will continue, see * (internal resolving on the query will continue, see
* \c getLookupTimeout()) * \c getLookupTimeout())
* *
* \returns Timeout for outgoing queries * \return Timeout for outgoing queries
*/ */
int getClientTimeout() const; int getClientTimeout() const;
......
...@@ -109,8 +109,7 @@ public: ...@@ -109,8 +109,7 @@ public:
/// \name pure virtuals, every derived class must implement these /// \name pure virtuals, every derived class must implement these
/// \returns true if the other ElementPtr has the same type and /// \return true if the other ElementPtr has the same type and value
/// value
virtual bool equals(const Element& other) const = 0; virtual bool equals(const Element& other) const = 0;
/// Converts the Element to JSON format and appends it to /// Converts the Element to JSON format and appends it to
......
...@@ -93,8 +93,8 @@ public: ...@@ -93,8 +93,8 @@ public:
void setLocalConfig(isc::data::ElementPtr config) { _config = config; } void setLocalConfig(isc::data::ElementPtr config) { _config = config; }
/// Returns the local (i.e. non-default) configuration. /// Returns the local (i.e. non-default) configuration.
/// \returns An ElementPtr pointing to a MapElement containing all /// \return An ElementPtr pointing to a MapElement containing all
/// non-default configuration options. /// non-default configuration options.
isc::data::ElementPtr getLocalConfig() { return (_config); } isc::data::ElementPtr getLocalConfig() { return (_config); }
/// Returns a list of all possible configuration options as specified /// Returns a list of all possible configuration options as specified
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment