fix: documentation for sorter and callback function

desdic · Feb 18, 2024 · 6bd7ae4 · 6bd7ae4
1 parent d550b93
commit 6bd7ae4
Show file tree

Hide file tree

Showing 4 changed files with 32 additions and 20 deletions.
diff --git a/doc/marlin.txt b/doc/marlin.txt
@@ -208,30 +208,36 @@ Usage ~
 
 ==============================================================================
 ------------------------------------------------------------------------------
-                                                             *M.change_buffer()*
-                        `M.change_buffer`({bufnr}, {_})
+Marlin callbacks
+
+------------------------------------------------------------------------------
+                                                     *callbacks.change_buffer()*
+                    `callbacks.change_buffer`({bufnr}, {_})
 Parameters ~
 {bufnr} `(number)` buffer id
 
 ------------------------------------------------------------------------------
-                                                                 *M.use_split()*
-                          `M.use_split`({bufnr}, {_})
+                                                         *callbacks.use_split()*
+                      `callbacks.use_split`({bufnr}, {_})
 Parameters ~
 {bufnr} `(number)` buffer id
 
 
 ==============================================================================
 ------------------------------------------------------------------------------
-                                                                 *M.by_buffer()*
-                           `M.by_buffer`({filelist})
+Marlin sorters
+
+------------------------------------------------------------------------------
+                                                           *sorters.by_buffer()*
+                        `sorters.by_buffer`({filelist})
 Sort indexes by open buffers (Same order like bufferline shows them)
 
 Parameters ~
 {filelist} marlin.file[]
 
 ------------------------------------------------------------------------------
-                                                                   *M.by_name()*
-                            `M.by_name`({filelist})
+                                                             *sorters.by_name()*
+                         `sorters.by_name`({filelist})
 Sort indexes by path + filename
 
 Parameters ~

diff --git a/doc/tags b/doc/tags
@@ -1,7 +1,5 @@
-M.by_buffer()	marlin.txt	/*M.by_buffer()*
-M.by_name()	marlin.txt	/*M.by_name()*
-M.change_buffer()	marlin.txt	/*M.change_buffer()*
-M.use_split()	marlin.txt	/*M.use_split()*
+callbacks.change_buffer()	marlin.txt	/*callbacks.change_buffer()*
+callbacks.use_split()	marlin.txt	/*callbacks.use_split()*
 default	marlin.txt	/*default*
 marlin	marlin.txt	/*marlin*
 marlin.add()	marlin.txt	/*marlin.add()*
@@ -17,3 +15,5 @@ marlin.remove()	marlin.txt	/*marlin.remove()*
 marlin.remove_all()	marlin.txt	/*marlin.remove_all()*
 marlin.setup()	marlin.txt	/*marlin.setup()*
 marlin.sort()	marlin.txt	/*marlin.sort()*
+sorters.by_buffer()	marlin.txt	/*sorters.by_buffer()*
+sorters.by_name()	marlin.txt	/*sorters.by_name()*
diff --git a/lua/marlin/callbacks.lua b/lua/marlin/callbacks.lua
@@ -1,12 +1,15 @@
-local M = {}
+--- Marlin callbacks
+
+-- Module definition ==========================================================
+local callbacks = {}
 
 ---@param bufnr number buffer id
-M.change_buffer = function(bufnr, _)
+callbacks.change_buffer = function(bufnr, _)
     vim.api.nvim_set_current_buf(bufnr)
 end
 
 ---@param bufnr number buffer id
-M.use_split = function(bufnr, _)
+callbacks.use_split = function(bufnr, _)
     local wins = vim.api.nvim_tabpage_list_wins(0)
     for _, win in ipairs(wins) do
         local winbufnr = vim.api.nvim_win_get_buf(win)
@@ -20,4 +23,4 @@ M.use_split = function(bufnr, _)
     vim.api.nvim_set_current_buf(bufnr)
 end
 
-return M
+return callbacks
diff --git a/lua/marlin/sorters.lua b/lua/marlin/sorters.lua
@@ -1,11 +1,14 @@
-local M = {}
+--- Marlin sorters
+
+-- Module definition ==========================================================
+local sorters = {}
 
 local utils = require("marlin.utils")
 
 --- Sort indexes by open buffers (Same order like bufferline shows them)
 ---
 ---@param filelist marlin.file[]
-M.by_buffer = function(filelist)
+sorters.by_buffer = function(filelist)
     local index = 1
     for _, bufnr in ipairs(vim.api.nvim_list_bufs()) do
         if vim.fn.getbufinfo(bufnr)[1].listed == 1 then
@@ -27,10 +30,10 @@ end
 --- Sort indexes by path + filename
 ---
 ---@param filelist marlin.file[]
-M.by_name = function(filelist)
+sorters.by_name = function(filelist)
     table.sort(filelist, function(a, b)
         return a.filename > b.filename
     end)
 end
 
-return M
+return sorters