From f2979eb08ba1e879dbe6075c7e4180c19b91a30a Mon Sep 17 00:00:00 2001
From: Gunnar Beutner <gunnar.beutner@netways.de>
Date: Tue, 10 Jul 2012 12:51:53 +0200
Subject: [PATCH] Added documentation for the logger classes.

---
 base/consolelogger.cpp | 10 ++++++++++
 base/consolelogger.h   |  3 +++
 base/logger.cpp        | 21 +++++++++++++++++++++
 base/logger.h          |  8 ++++++++
 4 files changed, 42 insertions(+)

diff --git a/base/consolelogger.cpp b/base/consolelogger.cpp
index 23357ab8d..bd89b3a85 100644
--- 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 de00cb670..93c525b7e 100644
--- 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 6b16252ef..1ecee90c9 100644
--- 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 eba3b78ae..f3614d6f2 100644
--- 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:
-- 
2.40.0