Commit 4d18d306 authored by Jeremy C. Reed's avatar Jeremy C. Reed

[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.
parent 12114c5c
......@@ -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.
......
......@@ -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&) {
}
......
......@@ -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.
///
......
......@@ -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
......
......@@ -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,
......
......@@ -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);
......
......@@ -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)
......
......@@ -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.
......
......@@ -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;
......
......@@ -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 {
......
......@@ -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
......
......@@ -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
......
......@@ -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);
}
......
......@@ -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
......
......@@ -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);
......
......@@ -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,
......
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