Move documentation form new() to constructor method

Author: Tastyep

lua/structlog/logger.lua

@@ -4,6 +4,11 @@
 -- @type Logger
 local Logger = {}
 
+--- Create a new logger
+-- @function Logger
+-- @param name The name of the logger
+-- @param level The logging level of the logger
+-- @param sinks The list of sinks to write the log entries in
 setmetatable(Logger, {
   __call = function(cls, ...)
     return cls:new(...)
@@ -12,11 +17,6 @@ setmetatable(Logger, {
 
 local Level = require("structlog.level")
 
---- Create a new logger
--- @function new
--- @param name The name of the logger
--- @param level The logging level of the logger
--- @param sinks The list of sinks to write the log entries in
 function Logger:new(name, level, sinks)
   local logger = {}
 

lua/structlog/sinks/console.lua

@@ -5,18 +5,18 @@
 local Console = {}
 local KeyValue = require("structlog.formatters.key_value")
 
+--- Create a new console writer
+-- @function Console
+-- @param opts Optional parameters
+-- @param opts.async Make the logger async, default: True
+-- @param opts.processors The list of processors to chain the log entries in
+-- @param opts.formatter The formatter to format the log entries
 setmetatable(Console, {
   __call = function(cls, ...)
     return cls:new(...)
   end,
 })
 
---- Create a new console writer
--- @function new
--- @param opts Optional parameters
--- @param opts.async Make the logger async, default: True
--- @param opts.processors The list of processors to chain the log entries in
--- @param opts.formatter The formatter to format the log entries
 function Console:new(opts)
   opts = opts or {}
 

lua/structlog/sinks/file.lua

@@ -5,17 +5,18 @@
 local File = {}
 local KeyValue = require("structlog.formatters.key_value")
 
+--- Create a new file writer.
+-- @function File
+-- @param path The path to the logging file
+-- @param opts Optional parameters
+-- @param opts.processors The list of processors to chain the log entries in
+-- @param opts.formatter The formatter to format the log entries
 setmetatable(File, {
   __call = function(cls, ...)
     return cls:new(...)
   end,
 })
 
---- Create a new file writer.
--- @param path The path to the logging file
--- @param opts Optional parameters
--- @param opts.processors The list of processors to chain the log entries in
--- @param opts.formatter The formatter to format the log entries
 function File:new(path, opts)
   opts = opts or {}
 

lua/structlog/sinks/rotating_file.lua

@@ -5,20 +5,21 @@
 local RotatingFile = {}
 local File = require("structlog.sinks.file")
 
-setmetatable(RotatingFile, {
-  __call = function(cls, ...)
-    return cls:new(...)
-  end,
-})
-
 --- Create a new rotating file writer.
+-- @function RotatingFile
 -- @param path The path to the logging file
 -- @param opts Optional parameters
 -- @param opts.processors The list of processors to chain the log entries in
 -- @param opts.formatter The formatter to format the log entries
 -- @param opts.max_size Maximum size of the file in bytes
 -- @param opts.max_age Maximum age of the file is seconds
 -- @param opts.time_format The time format used for renaming the log, default: "%F-%H:%M:%S"
+setmetatable(RotatingFile, {
+  __call = function(cls, ...)
+    return cls:new(...)
+  end,
+})
+
 function RotatingFile:new(path, opts)
   opts = opts or {}