BIND 10 trac2945, updated. 93445f2e2a578c547adb2b9e5443468165636383 [trac2945] miscellaneous doxygen warnings worked on
BIND 10 source code commits
bind10-changes at lists.isc.org
Wed May 8 23:30:33 UTC 2013
The branch, trac2945 has been updated
via 93445f2e2a578c547adb2b9e5443468165636383 (commit)
from c6603decaadcd33ccf9aee4a7b22447acec4b7f6 (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 93445f2e2a578c547adb2b9e5443468165636383
Author: Jeremy C. Reed <jreed at isc.org>
Date: Wed May 8 18:29:23 2013 -0500
[trac2945] miscellaneous doxygen warnings worked on
Still have lots to do.
Some of these marked with TODO indicating needing further work
(but better than it was before).
-----------------------------------------------------------------------
Summary of changes:
src/bin/auth/auth_srv.cc | 1 +
src/bin/auth/auth_srv.h | 1 +
src/bin/dhcp6/ctrl_dhcp6_srv.h | 2 +-
src/lib/asiolink/io_address.h | 4 ++--
src/lib/cc/session.h | 2 +-
src/lib/datasrc/cache_config.h | 2 +-
src/lib/datasrc/client_list.h | 4 ++--
src/lib/datasrc/memory/domaintree.h | 2 ++
src/lib/datasrc/memory/rdataset.h | 2 +-
src/lib/datasrc/memory/zone_data_updater.h | 4 ++--
src/lib/datasrc/memory/zone_table.h | 2 --
src/lib/datasrc/memory/zone_table_segment.h | 2 +-
src/lib/datasrc/memory/zone_writer_local.h | 4 ++--
src/lib/datasrc/sqlite3_accessor.cc | 1 +
src/lib/datasrc/zone_finder.h | 6 +++---
src/lib/dhcpsrv/dbaccess_parser.h | 3 ++-
src/lib/dhcpsrv/dhcp_config_parser.h | 2 +-
src/lib/dns/masterload.h | 2 +-
src/lib/dns/nsec3hash.h | 4 ++--
src/lib/util/interprocess_sync_file.h | 2 +-
src/lib/util/interprocess_sync_null.h | 2 +-
tests/tools/perfdhcp/stats_mgr.h | 1 +
22 files changed, 30 insertions(+), 25 deletions(-)
-----------------------------------------------------------------------
diff --git a/src/bin/auth/auth_srv.cc b/src/bin/auth/auth_srv.cc
index 90efee7..4500260 100644
--- a/src/bin/auth/auth_srv.cc
+++ b/src/bin/auth/auth_srv.cc
@@ -299,6 +299,7 @@ public:
///
/// \param server The DNSServer as passed to processMessage()
/// \param message The response as constructed by processMessage()
+ /// \param stats_attrs TODO
/// \param done If true, it indicates there is a response.
/// this value will be passed to server->resume(bool)
void resumeServer(isc::asiodns::DNSServer* server,
diff --git a/src/bin/auth/auth_srv.h b/src/bin/auth/auth_srv.h
index 8ad72be..a614918 100644
--- a/src/bin/auth/auth_srv.h
+++ b/src/bin/auth/auth_srv.h
@@ -104,6 +104,7 @@ public:
/// process. It's normally a reference to an xfr::XfroutClient object,
/// but can refer to a local mock object for testing (or other
/// experimental) purposes.
+ /// \param ddns_forwarder TODO
AuthSrv(isc::xfr::AbstractXfroutClient& xfrout_client,
isc::util::io::BaseSocketSessionForwarder& ddns_forwarder);
~AuthSrv();
diff --git a/src/bin/dhcp6/ctrl_dhcp6_srv.h b/src/bin/dhcp6/ctrl_dhcp6_srv.h
index ffd43c3..f1dc1d7 100644
--- a/src/bin/dhcp6/ctrl_dhcp6_srv.h
+++ b/src/bin/dhcp6/ctrl_dhcp6_srv.h
@@ -105,7 +105,7 @@ protected:
/// various configuration values. Installing the dummy handler
/// that guarantees to return success causes initial configuration
/// to be stored for the session being created and that it can
- /// be later accessed with \ref isc::ConfigData::getFullConfig.
+ /// be later accessed with \ref isc::ConfigData::getFullConfig TODO: cannot resolve reference.
///
/// @param new_config new configuration.
///
diff --git a/src/lib/asiolink/io_address.h b/src/lib/asiolink/io_address.h
index 5b11b87..17705d6 100644
--- a/src/lib/asiolink/io_address.h
+++ b/src/lib/asiolink/io_address.h
@@ -196,7 +196,7 @@ public:
///
/// \param other Address to compare against.
///
- /// See \ref smaller_than method for details.
+ /// See \ref lessThan method for details.
bool operator<(const IOAddress& other) const {
return (lessThan(other));
}
@@ -205,7 +205,7 @@ public:
///
/// \param other Address to compare against.
///
- /// See \ref smaller_equal method for details.
+ /// See \ref smallerEqual method for details.
bool operator<=(const IOAddress& other) const {
return (smallerEqual(other));
}
diff --git a/src/lib/cc/session.h b/src/lib/cc/session.h
index 63bb41c..e9a3375 100644
--- a/src/lib/cc/session.h
+++ b/src/lib/cc/session.h
@@ -163,7 +163,7 @@ namespace isc {
/// @brief returns socket descriptor from underlying socket connection
///
- /// @param returns socket descriptor used for session connection
+ /// @return socket descriptor used for session connection
virtual int getSocketDesc() const;
private:
// The following two methods are virtual to allow tests steal and
diff --git a/src/lib/datasrc/cache_config.h b/src/lib/datasrc/cache_config.h
index 7781f49..ac16415 100644
--- a/src/lib/datasrc/cache_config.h
+++ b/src/lib/datasrc/cache_config.h
@@ -168,7 +168,7 @@ public:
/// \param zone_name The origin name of the zone
/// \return A \c LoadAction functor to load zone data or an empty functor
/// (see above).
- memory::LoadAction getLoadAction(const dns::RRClass& rrlcass,
+ memory::LoadAction getLoadAction(const dns::RRClass& rrclass,
const dns::Name& zone_name) const;
/// \brief Read only iterator type over configured cached zones.
diff --git a/src/lib/datasrc/client_list.h b/src/lib/datasrc/client_list.h
index a5a7488..813f3dd 100644
--- a/src/lib/datasrc/client_list.h
+++ b/src/lib/datasrc/client_list.h
@@ -279,8 +279,8 @@ typedef boost::shared_ptr<ClientList> ClientListPtr;
/// \brief Shared const pointer to the list.
typedef boost::shared_ptr<const ClientList> ConstClientListPtr;
-/// \Concrete implementation of the ClientList, which is constructed based on
-/// configuration.
+/// \brief Concrete implementation of the ClientList, which is constructed
+/// based on configuration.
///
/// This is the implementation which is expected to be used in the servers.
/// However, it is expected most of the code will use it as the ClientList,
diff --git a/src/lib/datasrc/memory/domaintree.h b/src/lib/datasrc/memory/domaintree.h
index d503a11..4084ad8 100644
--- a/src/lib/datasrc/memory/domaintree.h
+++ b/src/lib/datasrc/memory/domaintree.h
@@ -960,6 +960,7 @@ public:
///
/// \param mem_sgmt A \c MemorySegment from which memory for the new
/// \c DomainTree is allocated.
+ /// \param return_empty_node TODO
static DomainTree* create(util::MemorySegment& mem_sgmt,
bool return_empty_node = false)
{
@@ -1332,6 +1333,7 @@ public:
/// \param mem_sgmt The \c MemorySegment object used to insert the nodes
/// (which was also used for creating the tree due to the requirement of
/// \c inert()).
+ /// \param deleter A deleter functor or function to delete node data.
template <typename DataDeleter>
void deleteAllNodes(util::MemorySegment& mem_sgmt, DataDeleter deleter);
diff --git a/src/lib/datasrc/memory/rdataset.h b/src/lib/datasrc/memory/rdataset.h
index 58201b1..f852e12 100644
--- a/src/lib/datasrc/memory/rdataset.h
+++ b/src/lib/datasrc/memory/rdataset.h
@@ -244,7 +244,7 @@ public:
/// needs to be extended, unless there's a reason other than simply
/// because it's already a member function.
///
- /// \param rdata_head A pointer to \c RdataSet from which the search
+ /// \param rdataset_head A pointer to \c RdataSet from which the search
/// starts. It can be NULL.
/// \param type The RRType of \c RdataSet to find.
/// \param sigonly_ok Whether it should find an RdataSet that only has
diff --git a/src/lib/datasrc/memory/zone_data_updater.h b/src/lib/datasrc/memory/zone_data_updater.h
index 9d669a0..8d67b95 100644
--- a/src/lib/datasrc/memory/zone_data_updater.h
+++ b/src/lib/datasrc/memory/zone_data_updater.h
@@ -63,8 +63,8 @@ public:
/// \param rrclass The RRclass of the zone data.
/// \param zone_name The Name of the zone under which records will be
/// added.
- // \param zone_data The ZoneData object which is populated with
- // record data.
+ /// \param zone_data The ZoneData object which is populated with
+ /// record data.
ZoneDataUpdater(util::MemorySegment& mem_sgmt,
isc::dns::RRClass rrclass,
const isc::dns::Name& zone_name,
diff --git a/src/lib/datasrc/memory/zone_table.h b/src/lib/datasrc/memory/zone_table.h
index 2774df3..7147fde 100644
--- a/src/lib/datasrc/memory/zone_table.h
+++ b/src/lib/datasrc/memory/zone_table.h
@@ -133,8 +133,6 @@ public:
///
/// \param mem_sgmt The \c MemorySegment that allocated memory for
/// \c ztable and used for prior calls to \c addZone().
- /// \param zone_class The RR class of the zone. It must be the RR class
- /// that is supposed to be associated to the zone table.
/// \param ztable A non NULL pointer to a valid \c ZoneTable object
/// that was originally created by the \c create() method (the behavior
/// is undefined if this condition isn't met).
diff --git a/src/lib/datasrc/memory/zone_table_segment.h b/src/lib/datasrc/memory/zone_table_segment.h
index 1440a2e..ade1221 100644
--- a/src/lib/datasrc/memory/zone_table_segment.h
+++ b/src/lib/datasrc/memory/zone_table_segment.h
@@ -133,7 +133,7 @@ public:
/// This creates a new write that can be used to update zones
/// inside this zone table segment.
///
- /// \param loadAction Callback to provide the actual data.
+ /// \param load_action Callback to provide the actual data.
/// \param origin The origin of the zone to reload.
/// \param rrclass The class of the zone to reload.
/// \return New instance of a zone writer. The ownership is passed
diff --git a/src/lib/datasrc/memory/zone_writer_local.h b/src/lib/datasrc/memory/zone_writer_local.h
index 7231a57..e387433 100644
--- a/src/lib/datasrc/memory/zone_writer_local.h
+++ b/src/lib/datasrc/memory/zone_writer_local.h
@@ -39,10 +39,10 @@ public:
///
/// \param segment The zone table segment to store the zone into.
/// \param load_action The callback used to load data.
- /// \param install_action The callback used to install the loaded zone.
+ /// \param origin The origin of the zone.
/// \param rrclass The class of the zone.
ZoneWriterLocal(ZoneTableSegmentLocal* segment,
- const LoadAction& load_action, const dns::Name& name,
+ const LoadAction& load_action, const dns::Name& origin,
const dns::RRClass& rrclass);
/// \brief Destructor
diff --git a/src/lib/datasrc/sqlite3_accessor.cc b/src/lib/datasrc/sqlite3_accessor.cc
index 93f468c..9321bed 100644
--- a/src/lib/datasrc/sqlite3_accessor.cc
+++ b/src/lib/datasrc/sqlite3_accessor.cc
@@ -903,6 +903,7 @@ public:
/// sequence. Note that because of serial number rollover, it may well
/// be that the start serial number is greater than the end one.
///
+ /// \param accessor The accessor to the database to use to get data.
/// \param zone_id ID of the zone (in the zone table)
/// \param start Serial number of first version in difference sequence
/// \param end Serial number of last version in difference sequence
diff --git a/src/lib/datasrc/zone_finder.h b/src/lib/datasrc/zone_finder.h
index 83851f6..13fccc5 100644
--- a/src/lib/datasrc/zone_finder.h
+++ b/src/lib/datasrc/zone_finder.h
@@ -648,10 +648,10 @@ public:
/// proofs, wildcard information etc. The options parameter works the
/// same way and it should conform to the same exception restrictions.
///
- /// \param name \see find, parameter name
+ /// \param name see find(), parameter name
/// \param target the successfull result is returned through this
- /// \param options \see find, parameter options
- /// \return \see find and it's result
+ /// \param options see find(), parameter options
+ /// \return see find() and its result
virtual boost::shared_ptr<Context> findAll(
const isc::dns::Name& name,
std::vector<isc::dns::ConstRRsetPtr> &target,
diff --git a/src/lib/dhcpsrv/dbaccess_parser.h b/src/lib/dhcpsrv/dbaccess_parser.h
index 53e3f81..77c9845 100644
--- a/src/lib/dhcpsrv/dbaccess_parser.h
+++ b/src/lib/dhcpsrv/dbaccess_parser.h
@@ -94,7 +94,8 @@ public:
///
/// Creates an instance of this parser.
///
- /// @param name Name of the parameter used to access the configuration.
+ /// @param param_name Name of the parameter used to access the
+ /// configuration.
///
/// @return Pointer to a DbAccessParser. The caller is responsible for
/// destroying the parser after use.
diff --git a/src/lib/dhcpsrv/dhcp_config_parser.h b/src/lib/dhcpsrv/dhcp_config_parser.h
index 8abdfc8..9d340da 100644
--- a/src/lib/dhcpsrv/dhcp_config_parser.h
+++ b/src/lib/dhcpsrv/dhcp_config_parser.h
@@ -157,7 +157,7 @@ class ValueStorage {
/// @param name is the name of the parameter for which the data
/// value is desired.
///
- /// @return The paramater's data value of type <ValueType>.
+ /// @return The parameter's data value of type \<ValueType\>.
/// @throw DhcpConfigError if the parameter is not found.
ValueType getParam(const std::string& name) const {
typename std::map<std::string, ValueType>::const_iterator param
diff --git a/src/lib/dns/masterload.h b/src/lib/dns/masterload.h
index 44b3d62..5303785 100644
--- a/src/lib/dns/masterload.h
+++ b/src/lib/dns/masterload.h
@@ -234,7 +234,7 @@ void masterLoad(const char* const filename, const Name& origin,
/// each RRset.
/// \param source A string to use in error messages if zone content is bad
/// (e.g. the file name when reading from a file). If this value is NULL,
-/// or left out, the error will use the string '<unknown>'
+/// or left out, the error will use the string '\<unknown\>'.
void masterLoad(std::istream& input, const Name& origin,
const RRClass& zone_class, MasterLoadCallback callback,
const char* source = NULL);
diff --git a/src/lib/dns/nsec3hash.h b/src/lib/dns/nsec3hash.h
index f1ca1a3..42b5117 100644
--- a/src/lib/dns/nsec3hash.h
+++ b/src/lib/dns/nsec3hash.h
@@ -122,7 +122,7 @@ public:
/// (SHA-1) is supported
/// \param iterations the number of iterations
/// \param salt_data the salt data as a byte array
- /// \param salt_data_length the length of the salt data
+ /// \param salt_length the length of the salt data
static NSEC3Hash* create(uint8_t algorithm, uint16_t iterations,
const uint8_t* salt_data, size_t salt_length);
@@ -233,7 +233,7 @@ public:
/// (SHA-1) is supported
/// \param iterations the number of iterations
/// \param salt_data the salt data as a byte array
- /// \param salt_data_length the length of the salt data
+ /// \param salt_length the length of the salt data
virtual NSEC3Hash* create(uint8_t algorithm, uint16_t iterations,
const uint8_t* salt_data, size_t salt_length)
const = 0;
diff --git a/src/lib/util/interprocess_sync_file.h b/src/lib/util/interprocess_sync_file.h
index 153b391..029bdba 100644
--- a/src/lib/util/interprocess_sync_file.h
+++ b/src/lib/util/interprocess_sync_file.h
@@ -52,7 +52,7 @@ public:
///
/// Creates a file-based interprocess synchronization object
///
- /// \param name Name of the synchronization task. This has to be
+ /// \param task_name Name of the synchronization task. This has to be
/// identical among the various processes that need to be
/// synchronized for the same task.
InterprocessSyncFile(const std::string& task_name) :
diff --git a/src/lib/util/interprocess_sync_null.h b/src/lib/util/interprocess_sync_null.h
index be77514..063cbe5 100644
--- a/src/lib/util/interprocess_sync_null.h
+++ b/src/lib/util/interprocess_sync_null.h
@@ -31,7 +31,7 @@ public:
///
/// Creates a null interprocess synchronization object
///
- /// \param name Name of the synchronization task. This has to be
+ /// \param task_name Name of the synchronization task. This has to be
/// identical among the various processes that need to be
/// synchronized for the same task.
InterprocessSyncNull(const std::string& task_name) :
diff --git a/tests/tools/perfdhcp/stats_mgr.h b/tests/tools/perfdhcp/stats_mgr.h
index c51ba6d..eb747bb 100644
--- a/tests/tools/perfdhcp/stats_mgr.h
+++ b/tests/tools/perfdhcp/stats_mgr.h
@@ -260,6 +260,7 @@ public:
/// assumed dropped. Negative value disables it.
/// \param archive_enabled if true packets archive mode is enabled.
/// In this mode all packets are stored throughout the test execution.
+ /// \param boot_time time when test started TODO or is to be started?
ExchangeStats(const ExchangeType xchg_type,
const double drop_time,
const bool archive_enabled,
More information about the bind10-changes
mailing list