Browse Source

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

Mukund Sivaraman 12 years ago
parent
commit
1fa69473d8
2 changed files with 4 additions and 4 deletions
  1. 2 2
      src/lib/dns/rrset_collection.h
  2. 2 2
      src/lib/dns/rrset_collection_base.h

+ 2 - 2
src/lib/dns/rrset_collection.h

@@ -88,7 +88,7 @@ public:
     /// RRset(s) matching the \c name, \c rrclass and \c rrtype are
     /// removed from the collection.
     ///
-    /// \returns \c true if a matching RRset was deleted, \c false if no
+    /// \return \c true if a matching RRset was deleted, \c false if no
     /// such RRset exists.
     bool removeRRset(const isc::dns::Name& name,
                      const isc::dns::RRClass& rrclass,
@@ -103,7 +103,7 @@ public:
     /// \param name The name of the RRset to search for.
     /// \param rrclass The class of the RRset to search for.
     /// \param rrtype The type of the RRset to search for.
-    /// \returns The RRset if found, \c NULL otherwise.
+    /// \return The RRset if found, \c NULL otherwise.
     virtual isc::dns::ConstRRsetPtr find(const isc::dns::Name& name,
                                          const isc::dns::RRClass& rrclass,
                                          const isc::dns::RRType& rrtype) const;

+ 2 - 2
src/lib/dns/rrset_collection_base.h

@@ -47,7 +47,7 @@ public:
     /// \param name The name of the RRset to search for.
     /// \param rrtype The type of the RRset to search for.
     /// \param rrclass The class of the RRset to search for.
-    /// \returns The RRset if found, \c NULL otherwise.
+    /// \return The RRset if found, \c NULL otherwise.
     virtual isc::dns::ConstRRsetPtr find
         (const isc::dns::Name& name, const isc::dns::RRClass& rrclass,
          const isc::dns::RRType& rrtype)
@@ -88,7 +88,7 @@ protected:
         /// method must return \c false.
         ///
         /// \param other The other iterator to compare against.
-        /// \returns \c true if equal, \c false otherwise.
+        /// \return \c true if equal, \c false otherwise.
         virtual bool equals(Iter& other) = 0;
     };