From 6c5e7c4e0ccebe9c7f1cc7074395bbd3e702b7b8 Mon Sep 17 00:00:00 2001
From: Knut Ahlers <knut@ahlers.me>
Date: Tue, 28 Jul 2015 16:09:42 +0200
Subject: [PATCH] Added documentation

---
 logger/logger.go | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/logger/logger.go b/logger/logger.go
index e20412b..4972c8e 100644
--- a/logger/logger.go
+++ b/logger/logger.go
@@ -2,8 +2,10 @@ package logger
 
 import "fmt"
 
+// LogLevel defines a type for named log levels
 type LogLevel uint
 
+// Pre-Defined log levels to be used with this logging module
 const (
 	Error LogLevel = iota
 	Warning
@@ -16,32 +18,38 @@ type Logger struct {
 	Level LogLevel
 }
 
+// New instanciates a new Logger and sets the preferred log level
 func New(logLevel LogLevel) *Logger {
 	return &Logger{
 		Level: logLevel,
 	}
 }
 
+// Log is the filtered equivalent to fmt.Println
 func (l *Logger) Log(level LogLevel, line string) {
 	if l.Level >= level {
 		fmt.Println(line)
 	}
 }
 
+// LogF is the filtered equivalent to fmt.Printf
 func (l *Logger) LogF(level LogLevel, line string, args ...interface{}) {
 	if l.Level >= level {
 		fmt.Printf(line, args...)
 	}
 }
 
+// ErrorF executes LogF with Error level
 func (l *Logger) ErrorF(line string, args ...interface{}) {
 	l.LogF(Error, line, args...)
 }
 
+// InfoF executes LogF with Info level
 func (l *Logger) InfoF(line string, args ...interface{}) {
 	l.LogF(Info, line, args...)
 }
 
+// DebugF executes LogF with Debug level
 func (l *Logger) DebugF(line string, args ...interface{}) {
 	l.LogF(Debug, line, args...)
 }