Commit dd1809bf authored by Jeremy C. Reed's avatar Jeremy C. Reed

[jreed-doxygen] more doxygen improvements

fix some parameter names
add some TODOs (still need to be fixed)
minor grammar fix
add missing parameter
fix some doxygen tags
parent 70c1df71
......@@ -213,7 +213,7 @@ public:
/// \param name The owner name of the OPT RR. This must be the root name.
/// \param rrclass The RR class of the OPT RR.
/// \param rrtype This must specify the OPT RR type.
/// \param rrttl The TTL of the OPT RR.
/// \param ttl The TTL of the OPT RR.
/// \param rdata The RDATA of the OPT RR.
EDNS(const Name& name, const RRClass& rrclass, const RRType& rrtype,
const RRTTL& ttl, const rdata::Rdata& rdata);
......
......@@ -278,6 +278,7 @@ public:
/// name when possible in the context of zone dump. This is a future
/// TODO item.
///
/* TODO: why does this have a param when not in argument list? */
/// \param rrset A reference to a (derived class of) \c AbstractRRset object
/// whose content is to be converted.
/// \return A string representation of the RRset.
......
......@@ -118,7 +118,8 @@ public:
/// If resource allocation in rendering process fails, a corresponding
/// standard exception will be thrown.
///
/// \param buffer An output buffer to store the wire data.
/// \param renderer DNS message rendering context that encapsulates the
/// output buffer in which the RRTTL is to be stored.
void toWire(MessageRenderer& renderer) const;
/// \brief Render the \c RRTTL in the wire format.
///
......@@ -128,8 +129,7 @@ public:
/// If resource allocation in rendering process fails, a corresponding
/// standard exception will be thrown.
///
/// \param renderer DNS message rendering context that encapsulates the
/// output buffer in which the RRTTL is to be stored.
/// \param buffer An output buffer to store the wire data.
void toWire(OutputBuffer& buffer) const;
//@}
......
......@@ -34,7 +34,7 @@ extern std::string dprefix;
* \short Temporary interface to logging.
*
* This is a temporary function to do logging. It has wrong interface currently
* and should be replaced by something else. It's main purpose now is to mark
* and should be replaced by something else. Its main purpose now is to mark
* places where logging should happen. When it is removed, compiler will do
* our work of finding the places.
*
......@@ -51,6 +51,7 @@ extern std::string dprefix;
*
* @param message The message to log. The real interface will probably have
* more parameters.
* \param error_flag TODO
*/
void dlog(const std::string& message, bool error_flag=false);
......
......@@ -133,7 +133,7 @@ public:
/// \param name Name to expand
///
/// \return Name expanded with stored name
std::string useAsDefault(const std::string&) const;
std::string useAsDefault(const std::string& name) const;
private:
/// \brief Split Name into Components
......
......@@ -86,7 +86,7 @@ public:
/// const char* and adds them to the dictionary. The messages are added
/// using "Add".
///
/// \param data null-terminated array of const char* alternating ID and
/// \param elements null-terminated array of const char* alternating ID and
/// message text. This should be an odd number of elements long, the last
/// elemnent being NULL. If it is an even number of elements long, the
/// last ID is ignored.
......
......@@ -134,7 +134,7 @@ public:
/// \return Pointer to the desired logging level object.
static LevelPtr toLevel(int val, const LevelPtr& defaultLevel);
/// \param Convert String to Logging Level
/// \brief Convert String to Logging Level
///
/// Returns a logging level object corresponding to the given name. If the
/// name is invalid, an object of logging level DEBUG (the minimum debug
......@@ -145,7 +145,7 @@ public:
/// \return Pointer to the desired logging level object.
static LevelPtr toLevelLS(const LogString& sArg);
/// \param Convert String to Logging Level
/// \brief Convert String to Logging Level
///
/// Returns a logging level object corresponding to the given name. If the
/// name is invalid, the given default is returned.
......
......@@ -140,7 +140,7 @@ public:
///
/// Initialises the hash table.
///
/// \param CmpFn Compare function (or object) used to compare an object with
/// \param cmp Compare function (or object) used to compare an object with
/// to get the name to be used as a key in the table. The object should be
/// created via a "new" as ownership passes to the hash table. The hash
/// table will take the responsibility of deleting it.
......
......@@ -145,7 +145,7 @@ public:
/// \brief Set Maximum Size
///
/// \param new_size New maximum list size
/// \param max_size New maximum list size
virtual void setMaxSize(uint32_t max_size) {
max_size_ = max_size;
}
......
......@@ -60,10 +60,10 @@ public:
/// pointed to NameserverEntry which contains the address as well as it's
/// corresponding index. The user can update it's RTT with the index later.
///
/// \param namerserver A shared_ptr that points to a NameserverEntry object
/// \param nameserver A shared_ptr that points to a NameserverEntry object
/// the shared_ptr can avoid the NameserverEntry object being dropped while the
/// request is processing.
/// \param index The address's index in NameserverEntry's addresses vector
/// \param address The address's index in NameserverEntry's addresses vector
/// \param family Address family, V4_ONLY or V6_ONLY
NameserverAddress(const boost::shared_ptr<NameserverEntry>& nameserver,
const AddressEntry& address, AddressFamily family):
......
......@@ -60,7 +60,7 @@ public:
/// tests) should it use to ask questions.
/// \param zonehashsize Size of the zone hash table. The default value of
/// 1009 is the first prime number above 1000.
/// \param nshash size Size of the nameserver hash table. The default
/// \param nshashsize Size of the nameserver hash table. The default
/// value of 3001 is the first prime number over 3000, and by implication,
/// there is an assumption that there will be more nameservers than zones
/// in the store.
......
......@@ -157,7 +157,7 @@ public:
/// Updates the RTT for a particular address
///
/// \param address Address to update
/// \param RTT New RTT for the address
/// \param rtt New RTT for the address
void setAddressRTT(const asiolink::IOAddress& address, uint32_t rtt);
/// \brief Update RTT of the address that corresponding to the index
......
......@@ -74,6 +74,8 @@ public:
* \param name Name of the zone
* \param class_code Class of this zone (zones of different classes have
* different objects.
* \param nameserver_table TODO
* \param nameserver_lru TODO
* \todo Move to cc file, include the lookup (if NSAS uses resolver for
* everything)
*/
......
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