doc: generate

Author: towry

doc/commit-msg-sg.txt

@@ -7,8 +7,20 @@ Your plugin configuration with its default values.
 Default values:
 >
   CommitMsgSg.options = {
-      -- Prints useful logs about what event are triggered, and reasons actions are executed.
-      debug = false,
+    ---@type string|function
+    cwd = nil,
+    auto_setup_gitcommit = true,
+    auto_setup_command = true,
+    on_attach = nil,
+    ghost_text = "Thinking...",
+    -- customized function to generate prompt string.
+    prompt_gen = nil,
+    default_prompt = nil,
+    -- @private
+    executor = "sg",
+    -- Debug
+    -- @private
+    debug = false,
   }
 
 <
@@ -25,4 +37,28 @@ Usage ~
 `require("commit-msg-sg").setup()` (add `{}` with your |CommitMsgSg.options| table)
 
 
+==============================================================================
+------------------------------------------------------------------------------
+                                                    *M.fetch_git_diff_as_text()*
+                       `M.fetch_git_diff_as_text`({opts})
+Parameters ~
+{opts} {callback?: `(function,cmd?:table,cwd?:string})`
+parameters: {error?: string, output?:string}
+
+------------------------------------------------------------------------------
+                                                         *M.update_ghost_text()*
+                     `M.update_ghost_text`({bufnr}, {text})
+Update first line ghost text.
+Parameters ~
+{text} `(optional)` `(string)`
+
+
+==============================================================================
+------------------------------------------------------------------------------
+                                                                   *M.execute()*
+                  `M.execute`({bufnr}, {snippet}, {callback})
+@param snippet string
+@param callback function
+
+
  vim:tw=78:ts=8:noet:ft=help:norl:

doc/tags

@@ -1,2 +1,5 @@
 CommitMsgSg.options	commit-msg-sg.txt	/*CommitMsgSg.options*
 CommitMsgSg.setup()	commit-msg-sg.txt	/*CommitMsgSg.setup()*
+M.execute()	commit-msg-sg.txt	/*M.execute()*
+M.fetch_git_diff_as_text()	commit-msg-sg.txt	/*M.fetch_git_diff_as_text()*
+M.update_ghost_text()	commit-msg-sg.txt	/*M.update_ghost_text()*