Commit 09e4d880 authored by JINMEI Tatuya's avatar JINMEI Tatuya
Browse files

[master] Merge branch 'master' of ssh://git.bind10.isc.org/var/bind10/git/bind10

parents a28f9424 33a0d78c
......@@ -71,8 +71,8 @@ struct RequestContext {
///
/// \exception None
///
/// \parameter remote_address_param The remote IP address
/// \parameter tsig_param A valid pointer to the TSIG record included in
/// \param remote_address_param The remote IP address
/// \param tsig_param A valid pointer to the TSIG record included in
/// the request or NULL if the request doesn't contain a TSIG.
RequestContext(const IPAddress& remote_address_param,
const isc::dns::TSIGRecord* tsig_param) :
......
......@@ -125,7 +125,7 @@ BasicAction defaultActionLoader(data::ConstElementPtr action);
*
* The rest of the element are matches. The left side is the name of the
* match type (for example match for source IP address or match for message
* size). The <parameter> is whatever is needed to describe the match and
* size). The parameter is whatever is needed to describe the match and
* depends on the match type, the loader passes it verbatim to creator
* of that match type.
*
......@@ -148,7 +148,7 @@ public:
/**
* \brief Constructor.
*
* \param default_action The default action for created ACLs.
* \param defaultAction The default action for created ACLs.
* \param actionLoader is the loader which will be used to convert actions
* from their JSON representation. The default value is suitable for
* the BasicAction enum. If you did not specify the second
......@@ -202,7 +202,7 @@ public:
* parameters might look like, they are not checked in any way.
* Therefore it's up to the creator (or the check being created)
* to validate the data and throw if it is bad.
* \param Current loader calling this creator. This can be used
* \param loader Current loader calling this creator. This can be used
* to load subexpressions in case of compound check.
*/
virtual boost::shared_ptr<Check<Context> > create(
......
......@@ -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.
......
......@@ -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>
......@@ -328,10 +326,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 +336,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&) {
}
......
......@@ -18,7 +18,7 @@
#include <log/macros.h>
#include <cache/cache_messages.h>
/// \file logger.h
/// \file cache/logger.h
/// \brief Cache library global logger
///
/// This holds the logger for the cache library. It is a private header
......
......@@ -52,6 +52,8 @@ public:
virtual ~MessageCache();
/// \brief Look up message in cache.
/// \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.
///
......
......@@ -89,8 +89,8 @@ 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 Cache size information for each message/rrsets of
/// different classes.
ResolverClassCache(const CacheSizeInfo& cache_info);
/// \name Lookup Interfaces
......
......@@ -27,9 +27,9 @@ using namespace isc::nsas;
namespace isc {
namespace cache {
/// \enum RRset Trustworthiness
/// \enum RRsetTrustLevel
/// For detail of RRset trustworthiness, please refer to
/// RFC2181 section5.4.1.
/// RFC 2181 section 5.4.1.
/// Bigger value is more trustworthy.
enum RRsetTrustLevel {
/// Default trust for RRset.
......
......@@ -18,7 +18,7 @@
#include <cc/cc_messages.h>
#include <log/macros.h>
/// \file logger.h
/// \file cc/logger.h
/// \brief Command Channel library global logger
///
/// This holds the logger for the CC library. It is a private header
......
......@@ -254,7 +254,8 @@ SessionImpl::internalRead(const asio::error_code& error,
}
}
Session::Session(io_service& io_service) : impl_(new SessionImpl(io_service))
Session::Session(asio::io_service& io_service) :
impl_(new SessionImpl(io_service))
{}
Session::~Session() {
......
......@@ -18,7 +18,7 @@
#include <log/macros.h>
#include <datasrc/datasrc_messages.h>
/// \file logger.h
/// \file datasrc/logger.h
/// \brief Data Source library global logger
///
/// This holds the logger for the data source library. It is a private header
......
......@@ -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,
......@@ -226,7 +226,8 @@ public:
private:
/// \name Callback related methods
///
/// See the description of \c RBTree<T>::find() about callbacks.
/// See the description of \c RBTree<T>::find() at \ref callback
/// about callbacks.
///
/// These methods never throw an exception.
//@{
......@@ -702,6 +703,7 @@ public:
}
/// \brief Find with callback and node chain.
/// \anchor callback
///
/// This version of \c find() is specifically designed for the backend
/// of the \c InMemoryZoneFinder class, and implements all necessary
......
......@@ -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.
......@@ -668,7 +668,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)
......
......@@ -700,7 +700,7 @@ Name::split(const unsigned int first, const unsigned int n) const {
}
Name
Name::split(const unsigned level) const {
Name::split(const unsigned int level) const {
if (level >= getLabelCount()) {
isc_throw(OutOfRange, "invalid level for name split (" << level
<< ") for name " << *this);
......
......@@ -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.
......
......@@ -478,7 +478,7 @@ public:
/// \brief Return the current \c Rdata corresponding to the rdata cursor.
///
/// \return A reference to an \c rdata::::Rdata object corresponding
/// \return A reference to an \c rdata::Rdata object corresponding
/// to the rdata cursor.
virtual const rdata::Rdata& getCurrent() const = 0;
......
......@@ -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
......
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