Parcourir la source

[trac1166][jreed-doxygen] Resolved doxygen-related TODOs

And revert the change from jreed-doxygen to io_asio_socket.h.
Opened a ticket for that #1366.
Jeremy C. Reed il y a 13 ans
Parent
commit
b843d05fda

+ 0 - 2
src/lib/asiolink/io_asio_socket.h

@@ -82,8 +82,6 @@ class IOEndpoint;
 /// derived class for testing purposes rather than providing factory methods
 /// (i.e., getDummy variants below).
 ///
-/// TODO: Check if IOAsioSocket class is still needed
-///
 /// \param C Template parameter identifying type of the callback object.
 
 template <typename C>

+ 2 - 2
src/lib/cache/message_cache.h

@@ -52,8 +52,8 @@ public:
     virtual ~MessageCache();
 
     /// \brief Look up message in cache.
-    /// \param qname TODO
-    /// \param qtype TODO
+    /// \param qname Name of the domain for which the message is being sought.
+    /// \param qtype Type of the RR for which the message is being sought.
     /// \param message generated response message if the message entry
     ///        can be found.
     ///

+ 2 - 1
src/lib/cache/resolver_cache.h

@@ -89,7 +89,8 @@ public:
     ResolverClassCache(const isc::dns::RRClass& cache_class);
 
     /// \brief Construct Function.
-    /// \param cache_info TODO
+    /// \param cache_info Cache size information for each message/rrsets of
+    ///        different classes.
     ResolverClassCache(const CacheSizeInfo& cache_info);
 
     /// \name Lookup Interfaces

+ 0 - 2
src/lib/log/logger_manager_impl.h

@@ -59,8 +59,6 @@ public:
     /// This resets the hierachy of loggers back to their defaults.  This means
     /// that all non-root loggers (if they exist) are set to NOT_SET, and the
     /// root logger reset to logging informational messages.
-    ///
-    /// \return root_name BIND 10 name of the root logger
     static void processInit();
 
     /// \brief Process Specification

+ 2 - 2
src/lib/nsas/nameserver_address_store.h

@@ -94,8 +94,8 @@ public:
     ///
     /// \param zone Name of zone.
     /// \param class_code Class of the zone.
-    /// \param callback Callback object that would be called
-    /// \param family TODO, check above family too
+    /// \param callback Callback object that would be called.
+    /// \param family Address family for which lookup is being cancelled.
     void cancel(const std::string& zone, const dns::RRClass& class_code,
                 const boost::shared_ptr<AddressRequestCallback>& callback,
                 AddressFamily family = ANY_OK);

+ 11 - 6
src/lib/resolve/recursive_query.h

@@ -73,8 +73,10 @@ public:
     ///
     /// \param dns_service The DNS Service to perform the recursive
     ///        query on.
-    /// \param nsas TODO
-    /// \param cache TODO
+    /// \param nsas Nameserver address store, used to hold information about zone
+    ///        nameservers.
+    /// \param cache Resolver cache object, used to hold information about retrieved
+    ///        records.
     /// \param upstream Addresses and ports of the upstream servers
     ///        to forward queries to.
     /// \param upstream_root Addresses and ports of the root servers
@@ -135,8 +137,10 @@ public:
     /// object.
     ///
     /// \param question The question being answered <qname/qclass/qtype>
-    /// \param answer_message An output Message into which the final response will be copied
-    /// \param buffer An output buffer into which the intermediate responses will be copied
+    /// \param answer_message An output Message into which the final response will
+    ///        be copied.
+    /// \param buffer An output buffer into which the intermediate responses will
+    ///        be copied.
     /// \param server A pointer to the \c DNSServer object handling the client
     void resolve(const isc::dns::Question& question,
                  isc::dns::MessagePtr answer_message,
@@ -150,8 +154,9 @@ public:
     ///
     /// \param query_message the full query got from client.
     /// \param answer_message the full answer received from other server.
-    /// \param buffer TODO
-    /// \param server TODO
+    /// \param buffer Output buffer into which the responses will be copied.
+    /// \param server Server object that handles receipt and processing of the
+    ///               received messages.
     /// \param callback callback object
     void forward(isc::dns::ConstMessagePtr query_message,
                  isc::dns::MessagePtr answer_message,