Add documentation for quickfix actions (#869)

* Add documentation for quickfix actions

* [docgen] Update doc/telescope.txt
skip-checks: true

Co-authored-by: Github Actions <actions@github>

2 files changed, 42 insertions, 0 deletions

diff --git a/doc/telescope.txt b/doc/telescope.txt
index 2c5e712..dfe5a65 100644
--- a/doc/telescope.txt
+++ b/doc/telescope.txt
@@ -291,6 +291,40 @@ actions.git_track_branch({prompt_bufnr})          *actions.git_track_branch()*
         {prompt_bufnr} (number)  The prompt bufnr
 
 
+actions.send_selected_to_qflist()          *actions.send_selected_to_qflist()*
+    Sends the selected entries to the quickfix list, replacing the previous
+    entries.
+
+
+
+actions.add_selected_to_qflist()            *actions.add_selected_to_qflist()*
+    Adds the selected entries to the quickfix list, keeping the previous
+    entries.
+
+
+
+actions.send_to_qflist()                            *actions.send_to_qflist()*
+    Sends all entries to the quickfix list, replacing the previous entries.
+
+
+
+actions.add_to_qflist()                              *actions.add_to_qflist()*
+    Adds all entries to the quickfix list, keeping the previous entries.
+
+
+
+actions.smart_send_to_qflist()                *actions.smart_send_to_qflist()*
+    Sends the selected entries to the quickfix list, replacing the previous
+    entries. If no entry was selected, sends all entries.
+
+
+
+actions.smart_add_to_qflist()                  *actions.smart_add_to_qflist()*
+    Adds the selected entries to the quickfix list, keeping the previous
+    entries. If no entry was selected, adds all entries.
+
+
+
 actions.open_qflist()                                  *actions.open_qflist()*
     Open the quickfix list
 
diff --git a/lua/telescope/actions/init.lua b/lua/telescope/actions/init.lua
index f78eb01..b8b1957 100644
--- a/lua/telescope/actions/init.lua
+++ b/lua/telescope/actions/init.lua
@@ -516,18 +516,22 @@ local send_all_to_qf = function(prompt_bufnr, mode)
   vim.fn.setqflist(qf_entries, mode)
 end
 
+--- Sends the selected entries to the quickfix list, replacing the previous entries.
 actions.send_selected_to_qflist = function(prompt_bufnr)
   send_selected_to_qf(prompt_bufnr, 'r')
 end
 
+--- Adds the selected entries to the quickfix list, keeping the previous entries.
 actions.add_selected_to_qflist = function(prompt_bufnr)
   send_selected_to_qf(prompt_bufnr, 'a')
 end
 
+--- Sends all entries to the quickfix list, replacing the previous entries.
 actions.send_to_qflist = function(prompt_bufnr)
   send_all_to_qf(prompt_bufnr, 'r')
 end
 
+--- Adds all entries to the quickfix list, keeping the previous entries.
 actions.add_to_qflist = function(prompt_bufnr)
   send_all_to_qf(prompt_bufnr, 'a')
 end
@@ -541,10 +545,14 @@ local smart_send = function(prompt_bufnr, mode)
   end
 end
 
+--- Sends the selected entries to the quickfix list, replacing the previous entries.
+--- If no entry was selected, sends all entries.
 actions.smart_send_to_qflist = function(prompt_bufnr)
   smart_send(prompt_bufnr, 'r')
 end
 
+--- Adds the selected entries to the quickfix list, keeping the previous entries.
+--- If no entry was selected, adds all entries.
 actions.smart_add_to_qflist = function(prompt_bufnr)
   smart_send(prompt_bufnr, 'a')
 end