BIND 10 jreed-doxygen, updated. fb7f61b8d2e05fa89b908770b1d009f8cda03334 [jreed-doxygen] Resolved doxygen-related TODOs
BIND 10 source code commits
bind10-changes at lists.isc.org
Wed Aug 24 14:45:56 UTC 2011
The branch, jreed-doxygen has been updated
via fb7f61b8d2e05fa89b908770b1d009f8cda03334 (commit)
from 6d842a64386a5c64a5136cadb4a1e646ee1901e5 (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 fb7f61b8d2e05fa89b908770b1d009f8cda03334
Author: Stephen Morris <stephen at isc.org>
Date: Wed Aug 24 15:45:23 2011 +0100
[jreed-doxygen] Resolved doxygen-related TODOs
-----------------------------------------------------------------------
Summary of changes:
src/lib/asiolink/dummy_io_cb.h | 23 +++++++++++++++++------
src/lib/asiolink/io_asio_socket.h | 2 --
src/lib/cache/message_cache.h | 4 ++--
src/lib/cache/resolver_cache.h | 3 ++-
src/lib/log/logger_manager_impl.h | 2 --
src/lib/nsas/nameserver_address_store.h | 4 ++--
src/lib/resolve/recursive_query.h | 17 +++++++++++------
7 files changed, 34 insertions(+), 21 deletions(-)
-----------------------------------------------------------------------
diff --git a/src/lib/asiolink/dummy_io_cb.h b/src/lib/asiolink/dummy_io_cb.h
index bcaefe9..90d24a8 100644
--- a/src/lib/asiolink/dummy_io_cb.h
+++ b/src/lib/asiolink/dummy_io_cb.h
@@ -15,6 +15,7 @@
#ifndef __DUMMY_IO_CB_H
#define __DUMMY_IO_CB_H
+#include <cassert>
#include <iostream>
#include <asio/error.hpp>
@@ -39,20 +40,30 @@ public:
/// \brief Asynchronous I/O callback method
///
- /// TODO: explain why this method should never be called.
- /// This should be unused.
+ /// Should never be called, as this class is a convenience class provided
+ /// for instances where a socket is required but it is known that no
+ /// asynchronous operations will be carried out.
void operator()(asio::error_code)
{
- // TODO: log an error if this method ever gets called.
+ // If the function is called, there is a serious logic error in the
+ // program (this class should not be used as the callback class). As
+ // the asiolink module is too low-level for logging errors, use assert()
+ // to bug-check the program.
+ assert(false);
}
/// \brief Asynchronous I/O callback method
///
- /// TODO: explain why this method should never be called.
- /// This should be unused.
+ /// Should never be called, as this class is a convenience class provided
+ /// for instances where a socket is required but it is known that no
+ /// asynchronous operations will be carried out.
void operator()(asio::error_code, size_t)
{
- // TODO: log an error if this method ever gets called.
+ // If the function is called, there is a serious logic error in the
+ // program (this class should not be used as the callback class). As
+ // the asiolink module is too low-level for logging errors, use assert()
+ // to bug-check the program.
+ assert(false);
}
};
diff --git a/src/lib/asiolink/io_asio_socket.h b/src/lib/asiolink/io_asio_socket.h
index c0718d8..aeac63d 100644
--- a/src/lib/asiolink/io_asio_socket.h
+++ b/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>
diff --git a/src/lib/cache/message_cache.h b/src/lib/cache/message_cache.h
index 439d796..b418f23 100644
--- a/src/lib/cache/message_cache.h
+++ b/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.
///
diff --git a/src/lib/cache/resolver_cache.h b/src/lib/cache/resolver_cache.h
index 2d945c6..5630bd7 100644
--- a/src/lib/cache/resolver_cache.h
+++ b/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
diff --git a/src/lib/log/logger_manager_impl.h b/src/lib/log/logger_manager_impl.h
index d899ccd..f99f832 100644
--- a/src/lib/log/logger_manager_impl.h
+++ b/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
diff --git a/src/lib/nsas/nameserver_address_store.h b/src/lib/nsas/nameserver_address_store.h
index 6041240..1af535a 100644
--- a/src/lib/nsas/nameserver_address_store.h
+++ b/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);
diff --git a/src/lib/resolve/recursive_query.h b/src/lib/resolve/recursive_query.h
index 9124aad..9af2d72 100644
--- a/src/lib/resolve/recursive_query.h
+++ b/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,
More information about the bind10-changes
mailing list