Diff: logger.h

Revision:

1:f7e32e99f366

Parent:

0:7d428b9b277e

Child:

2:ce978c9ea3e8

--- a/logger.h	Sat Apr 16 08:48:55 2011 +0000
+++ b/logger.h	Sat Apr 16 15:34:45 2011 +0000
@@ -62,16 +62,35 @@
     LOG_LOCAL7    = 23,    /* reserved for local use */
 };
 
-/**
- * @class syslog
- * @brief syslog device (sender/client)
+/** brief syslog device (sender/client)
  */
 class logger {
 public:
+    /** init logger class
+     * @param p_eth EthernetNetIf class
+     * @param host syslog collctor (server)
+     */
     logger (EthernetNetIf *, char *); 
+
+    /** init logger class
+     * @param p_eth EthernetNetIf class
+     * @param host syslog collctor (server) hostname or IP address
+     * @param myname My hostname or IP address
+     */
     logger (EthernetNetIf *, char *, char *);
 
+    /** Send the message
+     * @param tag Process name
+     * @param content Message
+     */
     void send (LOG_SEVERITY, LOG_FACILITY, char *, char *);
+
+    /** Send the message
+     * @param sev Severity
+     * @param fac Facility
+     * @param tag Process name
+     * @param content Message
+     */
     void send (char *, char *);
 
 private: