Commit 93445f2e authored by Jeremy C. Reed's avatar Jeremy C. Reed
Browse files

[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).
parent c6603dec
......@@ -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,
......
......@@ -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();
......
......@@ -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.
///
......
......@@ -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));
}
......
......@@ -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
......
......@@ -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.
......
......@@ -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,
......
......@@ -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);
......
......@@ -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
......
......@@ -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,
......
......@@ -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).
......
......@@ -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
......
......@@ -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
......
......@@ -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
......
......@@ -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,
......
......@@ -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.
......
......@@ -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
......
......@@ -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);
......
......@@ -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;
......
......@@ -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) :
......
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