chore(docs): auto-generate :help doc

Author: numToStr

doc/Comment.txt

@@ -22,14 +22,14 @@ Core Lua API··································
 Language/Filetype detection·········································|comment.ft|
 Utilities························································|comment.utils|
 Operator-mode API···············································|comment.opfunc|
-Insert API·······················································|comment.extra|
+Extra API························································|comment.extra|
 
 ================================================================================
 Introduction                                                      *comment-nvim*
 
 Comment.nvim is a smart and powerful comment plugin for neovim. It supports
 dot-repeat, counts, line ('//') and block ('/* */') comments, and can be used
-with motion and text-objects. It has native integration with tressitter to
+with motion and text-objects. It has native integration with |tressitter| to
 support embedded filetypes like html, vue, markdown with codeblocks etc.
 
                                                              *comment.dotrepeat*
@@ -58,6 +58,10 @@ filetype also exists in the |comment.ft| then the commenting will be done using
 the string in |comment.ft| instead of using 'commentstring'. To override this
 behavior, you have to manually return the 'commentstring' from 'pre_hook'.
 
+                                                            *comment.sourcecode*
+Comment.nvim is FOSS provided under MIT license. All the source code is avaiable
+at https://github.com/numToStr/Comment.nvim
+
 ================================================================================
 Usage                                                            *comment.usage*
 
@@ -80,6 +84,10 @@ C.setup({config?})                                         *comment.usage.setup*
 
     Usage: ~
         >
+            -- Use default configuration
+            require('Comment').setup()
+
+            -- or with custom configuration
             require('Comment').setup({
                 ignore = '^$',
                 toggler = {
@@ -97,25 +105,64 @@ C.setup({config?})                                         *comment.usage.setup*
 ================================================================================
 Configuration                                                   *comment.config*
 
+                                                       *comment.config.defaults*
+Following is the default config for the |comment.usage.setup|. If you want to
+override, just modify the option that you want, then it will be merged with the
+default config.
+
+>
+    {
+        padding = true,
+        sticky = true,
+        ignore = nil,
+        toggler = {
+            line = 'gcc',
+            block = 'gbc',
+        },
+        opleader = {
+            line = 'gc',
+            block = 'gb',
+        },
+        extra = {
+            above = 'gcO',
+            below = 'gco',
+            eol = 'gcA',
+        },
+        mappings = {
+            basic = true,
+            extra = true,
+            extended = false,
+        },
+        pre_hook = nil,
+        post_hook = nil,
+    }
+<
+
 CommentConfig                                     *comment.config.CommentConfig*
     Plugin's configuration
 
     Fields: ~
-        {padding}    (boolean)              Controls space between the comment
-                                            and the line (default: 'true')
-        {sticky}     (boolean)              Whether cursor should stay at the
-                                            same position. Only works with NORMAL
-                                            mode mappings (default: 'true')
-        {ignore}     (string|fun():string)  Lua pattern used to ignore lines
-                                            during (un)comment (default: 'nil')
-        {mappings}   (Mappings|boolean)
+        {padding}    (boolean|fun():boolean)  Controls space between the comment
+                                              and the line (default: 'true')
+        {sticky}     (boolean)                Whether cursor should stay at the
+                                              same position. Only works in NORMAL
+                                              mode mappings (default: 'true')
+        {ignore}     (string|fun():string)    Lua pattern used to ignore lines
+                                              during (un)comment (default: 'nil')
+        {mappings}   (Mappings|false)         Enables |comment.keybindings|
+                                              NOTE: If given 'false', then the
+                                              plugin won't create any mappings
         {toggler}    (Toggler)
         {opleader}   (Opleader)
         {extra}      (ExtraMapping)
-        {pre_hook}   (fun(ctx):string)      Function to call before (un)comment
-                                            (default: 'nil')
-        {post_hook}  (fun(ctx))             Function to call after (un)comment
-                                            (default: 'nil')
+        {pre_hook}   (fun(ctx):string)        Function to call before (un)comment.
+                                              It is called with a {ctx} argument
+                                              of type |comment.utils.CommentCtx|
+                                              (default: 'nil')
+        {post_hook}  (fun(ctx))               Function to call after (un)comment.
+                                              It is called with a {ctx} argument
+                                              of type |comment.utils.CommentCtx|
+                                              (default: 'nil')
 
 
 Mappings                                               *comment.config.Mappings*
@@ -287,8 +334,6 @@ api.toggle                                                  *comment.api.toggle*
             api.toggle.blockwise.current(motion?, config?)
             api.toggle.blockwise.count(count, config?)
 
-            -- NORMAL mode
-
             -- Toggle current line (linewise) using C-/
             vim.keymap.set('n', '<C-_>', api.toggle.linewise.current)
 
@@ -309,19 +354,17 @@ api.toggle                                                  *comment.api.toggle*
                 { expr = true }
             )
 
-            -- VISUAL mode
-
             local esc = vim.api.nvim_replace_termcodes(
                 '<ESC>', true, false, true
             )
 
-            -- Linewise toggle (linewise)
+            -- Toggle selection (linewise)
             vim.keymap.set('x', '<leader>c', function()
                 vim.api.nvim_feedkeys(esc, 'nx', false)
                 api.toggle.linewise(vim.fn.visualmode())
             end)
 
-            -- Blockwise toggle (blockwise)
+            -- Toggle selection (blockwise)
             vim.keymap.set('x', '<leader>b', function()
                 vim.api.nvim_feedkeys(esc, 'nx', false)
                 api.toggle.blockwise(vim.fn.visualmode())
@@ -674,7 +717,7 @@ U.get_count_lines({count})                       *comment.utils.get_count_lines*
         {count}  (integer)  Probably 'vim.v.count'
 
     Returns: ~
-        {string[]}      of lines
+        {string[]}      List of lines
         {CommentRange}
 
 
@@ -685,7 +728,7 @@ U.get_lines({range})                                   *comment.utils.get_lines*
         {range}  (CommentRange)
 
     Returns: ~
-        {string[]}  of lines
+        {string[]}  List of lines
 
 
 U.unwrap_cstr({cstr})                                *comment.utils.unwrap_cstr*
@@ -843,7 +886,7 @@ Op.blockwise({param}, {partial?})                     *comment.opfunc.blockwise*
 
 
 ================================================================================
-Insert API                                                       *comment.extra*
+Extra API                                                        *comment.extra*
 
 Underlying functions that powers the |comment.api.insert| lua API.