LogLevel: Comment public functions

1 files changed, 4 insertions, 0 deletions

diff --git a/internal/loglevel/loglevel.go b/internal/loglevel/loglevel.go
index 74dd49f..b851e3a 100644
--- a/internal/loglevel/loglevel.go
+++ b/internal/loglevel/loglevel.go
@@ -9,10 +9,13 @@ import (
 	"path"
 )
 
+// Logger defines a logger that rotates the logs in a file
 type Logger struct {
 	fr *FileRotater
 }
 
+// Init creates a new logger
+// The dir is the path where the log file is stored
 func (l *Logger) Init(dir string) (*slog.Logger, error) {
 	err := os.MkdirAll(dir, 0o700)
 	if err != nil {
@@ -32,6 +35,7 @@ func (l *Logger) Init(dir string) (*slog.Logger, error) {
 	return slog.New(handler), nil
 }
 
+// Closes closes, meaning cleans up the logger file
 func (l *Logger) Close() error {
 	return l.fr.Close()
 }