BIND 10 jreed-doxygen, updated. 4d18d306085f15ff218dd7dca303aa53122aa2d3 [jreed-doxygen] fix various doxygen warnings
BIND 10 source code commits
bind10-changes at lists.isc.org
Thu Jul 14 16:08:06 UTC 2011
The branch, jreed-doxygen has been updated
via 4d18d306085f15ff218dd7dca303aa53122aa2d3 (commit)
from 12114c5c973d70be91bfe946962e4373fa4d890a (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 4d18d306085f15ff218dd7dca303aa53122aa2d3
Author: Jeremy C. Reed <jreed at ISC.org>
Date: Thu Jul 14 11:07:15 2011 -0500
[jreed-doxygen] fix various doxygen warnings
Fix some typos, wrong tags, get rid of bogus tags.
Added some TODOs directly into the docs -- so they will need to be
completed too.
-----------------------------------------------------------------------
Summary of changes:
src/lib/asiolink/dummy_io_cb.h | 7 ++++---
src/lib/asiolink/io_asio_socket.h | 18 ++++--------------
src/lib/cache/message_cache.h | 2 ++
src/lib/cache/resolver_cache.h | 3 +--
src/lib/datasrc/rbtree.h | 2 +-
src/lib/dns/message.h | 4 ++--
src/lib/dns/messagerenderer.cc | 2 --
src/lib/dns/rdatafields.h | 2 +-
src/lib/dns/tsigkey.h | 13 ++++++-------
src/lib/log/log_formatter.h | 2 +-
src/lib/log/logger_level_impl.h | 2 +-
src/lib/log/logger_manager_impl.h | 2 +-
src/lib/log/logger_specification.h | 2 +-
src/lib/log/message_dictionary.h | 2 +-
src/lib/nsas/nameserver_address_store.h | 3 +++
src/lib/resolve/recursive_query.h | 7 ++++++-
16 files changed, 35 insertions(+), 38 deletions(-)
-----------------------------------------------------------------------
diff --git a/src/lib/asiolink/dummy_io_cb.h b/src/lib/asiolink/dummy_io_cb.h
index 2081906..bcaefe9 100644
--- a/src/lib/asiolink/dummy_io_cb.h
+++ b/src/lib/asiolink/dummy_io_cb.h
@@ -39,7 +39,8 @@ public:
/// \brief Asynchronous I/O callback method
///
- /// \param error Unused
+ /// TODO: explain why this method should never be called.
+ /// This should be unused.
void operator()(asio::error_code)
{
// TODO: log an error if this method ever gets called.
@@ -47,8 +48,8 @@ public:
/// \brief Asynchronous I/O callback method
///
- /// \param error Unused
- /// \param length Unused
+ /// TODO: explain why this method should never be called.
+ /// This should be unused.
void operator()(asio::error_code, size_t)
{
// TODO: log an error if this method ever gets called.
diff --git a/src/lib/asiolink/io_asio_socket.h b/src/lib/asiolink/io_asio_socket.h
index 864708c..c0718d8 100644
--- a/src/lib/asiolink/io_asio_socket.h
+++ b/src/lib/asiolink/io_asio_socket.h
@@ -328,10 +328,9 @@ public:
///
/// A call that is a no-op on UDP sockets, this opens a connection to the
/// system identified by the given endpoint.
+ /// The endpoint and callback are unused.
///
- /// \param endpoint Unused
- /// \param callback Unused.
- ///false indicating that the operation completed synchronously.
+ /// \return false indicating that the operation completed synchronously.
virtual bool open(const IOEndpoint*, C&) {
return (false);
}
@@ -339,23 +338,14 @@ public:
/// \brief Send Asynchronously
///
/// Must be supplied as it is abstract in the base class.
- ///
- /// \param data Unused
- /// \param length Unused
- /// \param endpoint Unused
- /// \param callback Unused
+ /// This is unused.
virtual void asyncSend(const void*, size_t, const IOEndpoint*, C&) {
}
/// \brief Receive Asynchronously
///
/// Must be supplied as it is abstract in the base class.
- ///
- /// \param data Unused
- /// \param length Unused
- /// \param offset Unused
- /// \param endpoint Unused
- /// \param callback Unused
+ /// The parameters are unused.
virtual void asyncReceive(void* data, size_t, size_t, IOEndpoint*, C&) {
}
diff --git a/src/lib/cache/message_cache.h b/src/lib/cache/message_cache.h
index 44d7fd1..439d796 100644
--- a/src/lib/cache/message_cache.h
+++ b/src/lib/cache/message_cache.h
@@ -52,6 +52,8 @@ public:
virtual ~MessageCache();
/// \brief Look up message in cache.
+ /// \param qname TODO
+ /// \param qtype TODO
/// \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 9ad4388..2d945c6 100644
--- a/src/lib/cache/resolver_cache.h
+++ b/src/lib/cache/resolver_cache.h
@@ -89,8 +89,7 @@ public:
ResolverClassCache(const isc::dns::RRClass& cache_class);
/// \brief Construct Function.
- /// \param caches_size cache size information for each
- /// messages/rrsets of different classes.
+ /// \param cache_info TODO
ResolverClassCache(const CacheSizeInfo& cache_info);
/// \name Lookup Interfaces
diff --git a/src/lib/datasrc/rbtree.h b/src/lib/datasrc/rbtree.h
index 03a6967..19330fb 100644
--- a/src/lib/datasrc/rbtree.h
+++ b/src/lib/datasrc/rbtree.h
@@ -209,7 +209,7 @@ public:
/// \exception isc::InvalidParameter Unsettable flag is specified
/// \exception None otherwise
/// \param flag The node flag to be changed.
- /// \on If \c true, set the flag to on; otherwise set it to off.
+ /// \param on If \c true, set the flag to on; otherwise set it to off.
void setFlag(Flags flag, bool on = true) {
if ((flag & ~SETTABLE_FLAGS) != 0) {
isc_throw(isc::InvalidParameter,
diff --git a/src/lib/dns/message.h b/src/lib/dns/message.h
index fcc53e9..f4bd5c7 100644
--- a/src/lib/dns/message.h
+++ b/src/lib/dns/message.h
@@ -526,7 +526,7 @@ public:
/// source message to the same section of this message
///
/// \param section the section to append
- /// \param target The source Message
+ /// \param source The source Message
void appendSection(const Section section, const Message& source);
/// \brief Prepare for making a response from a request.
@@ -610,7 +610,7 @@ typedef boost::shared_ptr<const Message> ConstMessagePtr;
///
/// \param os A \c std::ostream object on which the insertion operation is
/// performed.
-/// \param record A \c Message object output by the operation.
+/// \param message A \c Message object output by the operation.
/// \return A reference to the same \c std::ostream object referenced by
/// parameter \c os after the insertion operation.
std::ostream& operator<<(std::ostream& os, const Message& message);
diff --git a/src/lib/dns/messagerenderer.cc b/src/lib/dns/messagerenderer.cc
index 767aca9..02f5519 100644
--- a/src/lib/dns/messagerenderer.cc
+++ b/src/lib/dns/messagerenderer.cc
@@ -150,8 +150,6 @@ private:
struct MessageRenderer::MessageRendererImpl {
/// \brief Constructor from an output buffer.
///
- /// \param buffer An \c OutputBuffer object to which wire format data is
- /// written.
MessageRendererImpl() :
nbuffer_(Name::MAX_WIRE), msglength_limit_(512),
truncated_(false), compress_mode_(MessageRenderer::CASE_INSENSITIVE)
diff --git a/src/lib/dns/rdatafields.h b/src/lib/dns/rdatafields.h
index e33bcd7..16880f0 100644
--- a/src/lib/dns/rdatafields.h
+++ b/src/lib/dns/rdatafields.h
@@ -296,7 +296,7 @@ public:
/// as long as the \c RdataFields object is used.
///
/// \param fields An array of \c FieldSpec entries. This can be \c NULL.
- /// \param nfields The number of entries of \c fields.
+ /// \param fields_length The total length of the \c fields.
/// \param data A pointer to memory region for the entire RDATA. This can
/// be NULL.
/// \param data_length The length of \c data in bytes.
diff --git a/src/lib/dns/tsigkey.h b/src/lib/dns/tsigkey.h
index 31211d1..6081dd3 100644
--- a/src/lib/dns/tsigkey.h
+++ b/src/lib/dns/tsigkey.h
@@ -113,10 +113,10 @@ public:
/// \brief Constructor from an input string
///
/// The string must be of the form:
- /// <name>:<secret>[:<algorithm>]
- /// Where <name> is a domain name for the key, <secret> is a
+ /// name:secret[:algorithm]
+ /// Where "name" is a domain name for the key, "secret" is a
/// base64 representation of the key secret, and the optional
- /// algorithm is an algorithm identifier as specified in RFC4635.
+ /// "algorithm" is an algorithm identifier as specified in RFC 4635.
/// The default algorithm is hmac-md5.sig-alg.reg.int.
///
/// The same restriction about the algorithm name (and secret) as that
@@ -188,11 +188,10 @@ public:
///
/// The resulting string will be of the form
/// name:secret:algorithm
- /// Where <name> is a domain name for the key, <secret> is a
- /// base64 representation of the key secret, and algorithm is
- /// an algorithm identifier as specified in RFC4635
+ /// Where "name" is a domain name for the key, "secret" is a
+ /// base64 representation of the key secret, and "algorithm" is
+ /// an algorithm identifier as specified in RFC 4635.
///
- /// \param key the TSIG key to convert
/// \return The string representation of the given TSIGKey.
std::string toText() const;
diff --git a/src/lib/log/log_formatter.h b/src/lib/log/log_formatter.h
index ca23844..7a9e5fa 100644
--- a/src/lib/log/log_formatter.h
+++ b/src/lib/log/log_formatter.h
@@ -169,7 +169,7 @@ public:
/// Deactivates the current formatter. In case the formatter is not active,
/// only produces another inactive formatter.
///
- /// \param arg The argument to place into the placeholder.
+ /// \param value The argument to place into the placeholder.
template<class Arg> Formatter& arg(const Arg& value) {
if (logger_) {
try {
diff --git a/src/lib/log/logger_level_impl.h b/src/lib/log/logger_level_impl.h
index 9289a1d..c990796 100644
--- a/src/lib/log/logger_level_impl.h
+++ b/src/lib/log/logger_level_impl.h
@@ -83,7 +83,7 @@ public:
/// The log4cplus log level may be non-standard in which case it is
/// encoding a BIND 10 debug level as well.
///
- /// \param level log4cplus log level
+ /// \param loglevel log4cplus log level
///
/// \return Equivalent BIND 10 severity and debug level
static
diff --git a/src/lib/log/logger_manager_impl.h b/src/lib/log/logger_manager_impl.h
index aa596a0..d899ccd 100644
--- a/src/lib/log/logger_manager_impl.h
+++ b/src/lib/log/logger_manager_impl.h
@@ -60,7 +60,7 @@ public:
/// that all non-root loggers (if they exist) are set to NOT_SET, and the
/// root logger reset to logging informational messages.
///
- /// \param root_name BIND 10 name of the root logger
+ /// \return root_name BIND 10 name of the root logger
static void processInit();
/// \brief Process Specification
diff --git a/src/lib/log/logger_specification.h b/src/lib/log/logger_specification.h
index 35c879c..6805fdd 100644
--- a/src/lib/log/logger_specification.h
+++ b/src/lib/log/logger_specification.h
@@ -103,7 +103,7 @@ public:
/// \brief Add output option.
///
- /// \param Option to add to the list.
+ /// \param option Option to add to the list.
void addOutputOption(const OutputOption& option) {
options_.push_back(option);
}
diff --git a/src/lib/log/message_dictionary.h b/src/lib/log/message_dictionary.h
index 23f76d7..519986d 100644
--- a/src/lib/log/message_dictionary.h
+++ b/src/lib/log/message_dictionary.h
@@ -79,7 +79,7 @@ public:
///
/// \return true if the message was added to the dictionary, false if the
/// message existed and it was not added.
- virtual bool add (const std::string& ident, const std::string& test);
+ virtual bool add (const std::string& ident, const std::string& text);
/// \brief Replace Message
diff --git a/src/lib/nsas/nameserver_address_store.h b/src/lib/nsas/nameserver_address_store.h
index 87845c9..6041240 100644
--- a/src/lib/nsas/nameserver_address_store.h
+++ b/src/lib/nsas/nameserver_address_store.h
@@ -92,7 +92,10 @@ public:
/// \brief cancel the given lookup action
///
+ /// \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
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 b9fb80d..9124aad 100644
--- a/src/lib/resolve/recursive_query.h
+++ b/src/lib/resolve/recursive_query.h
@@ -38,7 +38,7 @@ public:
///
/// Adds a round-trip time to the internal vector of times.
///
- /// \param RTT to record.
+ /// \param rtt RTT to record.
void addRtt(uint32_t rtt) {
rtt_.push_back(rtt);
}
@@ -73,6 +73,8 @@ public:
///
/// \param dns_service The DNS Service to perform the recursive
/// query on.
+ /// \param nsas TODO
+ /// \param cache TODO
/// \param upstream Addresses and ports of the upstream servers
/// to forward queries to.
/// \param upstream_root Addresses and ports of the root servers
@@ -147,6 +149,9 @@ public:
/// function resolve().
///
/// \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 callback callback object
void forward(isc::dns::ConstMessagePtr query_message,
isc::dns::MessagePtr answer_message,
More information about the bind10-changes
mailing list