]> granicus.if.org Git - pdns/commitdiff
Fix a few Doxygen comments
authorRuben Kerkhof <ruben@rubenkerkhof.com>
Mon, 6 Jan 2014 16:34:50 +0000 (17:34 +0100)
committerRuben Kerkhof <ruben@rubenkerkhof.com>
Mon, 6 Jan 2014 16:34:50 +0000 (17:34 +0100)
Found with clang -Wdocumentation

pdns/arguments.hh
pdns/logger.hh
pdns/mtasker.hh

index a0318540b85ee91794e4756ae0e41e056442b979..15773070605e4aa9d571bdcb10c542aa84ba36e7 100644 (file)
@@ -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); //<!< return value interpreted as octal number
+  mode_t asMode(const string &var); //!< return value interpreted as octal number
   uid_t asUid(const string &var); //!< return user id, resolves if necessary
   gid_t asGid(const string &var); //!< return group id, resolves if necessary
   double asDouble(const string &var); //!< return a variable value as a number
@@ -107,7 +107,7 @@ public:
   string helpstring(string prefix=""); //!< generates the --help
   string configstring(bool current=false); //!< generates the --mkconfig
   bool contains(const string &var, const string &val);
-  bool isEmpty(const string &var); //<! checks if variable has value
+  bool isEmpty(const string &var); //!< checks if variable has value
 
   vector<string>list();
   string getHelp(const string &item);
index 327842496cec0fcb7762378792f8dcc7f969592f..2c3b4496366546261e4899b3506bc5f8bc23392e 100644 (file)
@@ -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
index 31cd0c12d8641e8e0b3efe623e4b4e88f396a736..42cd5c5c455cb9e60fdf51d2f6de51f45b207e02 100644 (file)
@@ -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 EventKey=int, class EventVal=int> class MTasker