Added documentation for the logger classes.

diff --git a/base/consolelogger.cpp b/base/consolelogger.cpp
index 23357ab8d864ebca2ab60b3377fce8f2cdb09c07..bd89b3a855db215dc6ebd259b31d7a561f1d6213 100644 (file)
--- a/base/consolelogger.cpp
+++ b/base/consolelogger.cpp
@@ -2,10 +2,20 @@
 
 using namespace icinga;
 
+/**
+ * Constructor for the ConsoleLogger class.
+ *
+ * @param minSeverity Minimum severity for log messages.
+ */
 ConsoleLogger::ConsoleLogger(LogSeverity minSeverity)
        : Logger(minSeverity)
 { }
 
+/**
+ * Processes a log entry and outputs it to standard out.
+ *
+ * @param entry The log entry.
+ */
 void ConsoleLogger::ProcessLogEntry(const LogEntry& entry)
 {
        char timestamp[100];

diff --git a/base/consolelogger.h b/base/consolelogger.h
index de00cb6704e79697a7530337d1bdf4ee4fb5a450..93c525b7eddbc4c0acd426041556e30fca145332 100644 (file)
--- a/base/consolelogger.h
+++ b/base/consolelogger.h
@@ -4,6 +4,9 @@
 namespace icinga
 {
 
+/**
+ * A logger that logs to stderr.
+ */
 class ConsoleLogger : public Logger
 {
 public:

diff --git a/base/logger.cpp b/base/logger.cpp
index 6b16252effa142aa70996ee92ff94816eb537926..1ecee90c914e0d8e44456c1b5dedef38acbfa0ea 100644 (file)
--- a/base/logger.cpp
+++ b/base/logger.cpp
@@ -23,6 +23,12 @@ using namespace icinga;
 
 vector<Logger::Ptr> Logger::m_Loggers;
 
+/**
+ * Constructor for the logger class.
+ *
+ * @param minSeverity The minimum severity of log messages that should be sent
+ *                    to this logger.
+ */
 Logger::Logger(LogSeverity minSeverity)
        : m_MinSeverity(minSeverity)
 { }
@@ -48,16 +54,31 @@ void Logger::Write(LogSeverity severity, const string& facility,
        Event::Post(ev);
 }
 
+/**
+ * Registers a new logger.
+ *
+ * @param logger The logger.
+ */
 void Logger::RegisterLogger(const Logger::Ptr& logger)
 {
        m_Loggers.push_back(logger);
 }
 
+/**
+ * Retrieves the minimum severity for this logger.
+ *
+ * @returns The minimum severity.
+ */
 LogSeverity Logger::GetMinSeverity(void) const
 {
        return m_MinSeverity;
 }
 
+/**
+ * Forwards a log entry to the registered loggers.
+ *
+ * @param entry The log entry.
+ */
 void Logger::ForwardLogEntry(const LogEntry& entry)
 {
        vector<Logger::Ptr>::iterator it;

diff --git a/base/logger.h b/base/logger.h
index eba3b78aefb3e47bb7623d09a08f7ab7fc5c41a9..f3614d6f2caafeb42b3a93cd4b06e794a4fa5877 100644 (file)
--- a/base/logger.h
+++ b/base/logger.h
@@ -36,6 +36,11 @@ enum LogSeverity
        LogCritical
 };
 
+/**
+ * A lot entry.
+ *
+ * @ingroup base
+ */
 struct LogEntry {
        time_t Timestamp;
        LogSeverity Severity;
@@ -43,6 +48,9 @@ struct LogEntry {
        string Message;
 };
 
+/**
+ * Base class for all loggers.
+ */
 class I2_BASE_API Logger : public Object
 {
 public: