From 16276aa8abaf4e7a25e22e6251e4249740c4c45a Mon Sep 17 00:00:00 2001 From: Ruben Kerkhof Date: Mon, 6 Jan 2014 17:34:50 +0100 Subject: [PATCH] Fix a few Doxygen comments Found with clang -Wdocumentation --- pdns/arguments.hh | 4 ++-- pdns/logger.hh | 8 ++++---- pdns/mtasker.hh | 4 ++-- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/pdns/arguments.hh b/pdns/arguments.hh index a0318540b..157730706 100644 --- a/pdns/arguments.hh +++ b/pdns/arguments.hh @@ -96,7 +96,7 @@ public: bool parmIsset(const string &var); //!< Checks if a parameter is set to *a* value bool mustDo(const string &var); //!< if a switch is given, if we must do something (--help) int asNum(const string &var); //!< return a variable value as a number - mode_t asMode(const string &var); //list(); string getHelp(const string &item); diff --git a/pdns/logger.hh b/pdns/logger.hh index 327842496..2c3b44963 100644 --- a/pdns/logger.hh +++ b/pdns/logger.hh @@ -44,11 +44,11 @@ public: enum Urgency {All=99999,NTLog=12345,Alert=LOG_ALERT, Critical=LOG_CRIT, Error=LOG_ERR, Warning=LOG_WARNING, Notice=LOG_NOTICE,Info=LOG_INFO, Debug=LOG_DEBUG, None=-1}; - /** Log a message. - \param msg Message you wish to log - \param Urgency Urgency of the message you wish to log + /** Log a message. + \param msg Message you wish to log + \param u Urgency of the message you wish to log */ - void log(const string &msg, Urgency u=Notice); + void log(const string &msg, Urgency u=Notice); void setFacility(int f){d_facility=f;open();} //!< Choose logging facility void setFlag(int f){flags|=f;open();} //!< set a syslog flag diff --git a/pdns/mtasker.hh b/pdns/mtasker.hh index 31cd0c12d..42cd5c5c4 100644 --- a/pdns/mtasker.hh +++ b/pdns/mtasker.hh @@ -38,8 +38,8 @@ struct KeyTag {}; //! The main MTasker class /** The main MTasker class. See the main page for more information. - \param EventKey Type of the key with which events are to be identified. Defaults to int. - \param EventVal Type of the content or value of an event. Defaults to int. Cannot be set to void. + \tparam EventKey Type of the key with which events are to be identified. Defaults to int. + \tparam EventVal Type of the content or value of an event. Defaults to int. Cannot be set to void. \note The EventKey needs to have an operator< defined because it is used as the key of an associative array */ template class MTasker -- 2.40.0