Merge pull request #325 from pranavrao145/docs/full-setup

docs(full-setup): added full setup function and all default values to README

Author: pranavrao145

README.md

@@ -103,7 +103,7 @@ are supported (with individual support for each function may vary):
     normal mode:
     - Using this function in visual mode will print out whatever is in the
       visual selection.
-    - Setting `{ normal = true }` to the function will automatically find the variable
+    - Passing `{ normal = true }` to the function will automatically find the variable
       under the cursor and print it from normal mode without needing visual mode at all
   - **Cleanup:** Automated cleanup of all print statements generated by the
     plugin
@@ -121,6 +121,37 @@ setup function.
 require('refactoring').setup({})
 ```
 
+Here are all the available options for the setup function and their defaults:
+
+```lua
+require('refactoring').setup({
+    prompt_func_return_type = {
+        go = false,
+        java = false,
+
+        cpp = false,
+        c = false,
+        h = false,
+        hpp = false,
+        cxx = false,
+    },
+    prompt_func_param_type = {
+        go = false,
+        java = false,
+
+        cpp = false,
+        c = false,
+        h = false,
+        hpp = false,
+        cxx = false,
+    },
+    printf_statements = {},
+    print_var_statements = {},
+})
+```
+
+See each of the sections below for details on each configuration option.
+
 ### Configuration for Refactoring Operations<a name="config-refactoring"></a>
 
 #### Using Direct Remaps<a name="config-refactoring-direct"></a>
@@ -202,8 +233,8 @@ vim.api.nvim_set_keymap(
 
 -- Print var
 
--- Remap in normal mode will automatically find the variable under the cursor and print it
-vim.api.nvim_set_keymap("n", "<leader>rv", ":lua require('refactoring').debug.print_var({})<CR>", { noremap = true })
+-- Remap in normal mode and passing { normal = true } will automatically find the variable under the cursor and print it
+vim.api.nvim_set_keymap("n", "<leader>rv", ":lua require('refactoring').debug.print_var({ normal = true })<CR>", { noremap = true })
 -- Remap in visual mode will print whatever is in the visual selection
 vim.api.nvim_set_keymap("v", "<leader>rv", ":lua require('refactoring').debug.print_var({})<CR>", { noremap = true })
 
@@ -294,9 +325,5 @@ require('refactoring').setup({
         c = true,
         java = true,
     },
-    -- custom print_var_statements by language
-    print_var_statements = {}
-    -- custom printf_statements by language
-    printf_statements = {}
 })
 ```

lua/refactoring/config/init.lua

@@ -28,8 +28,8 @@ local default_formatting = {
 
 local default_prompt_func_param_type = {
     go = false,
+    java = false,
 
-    -- All of the cs
     cpp = false,
     c = false,
     h = false,
@@ -39,6 +39,13 @@ local default_prompt_func_param_type = {
 
 local default_prompt_func_return_type = {
     go = false,
+    java = false,
+
+    cpp = false,
+    c = false,
+    h = false,
+    hpp = false,
+    cxx = false,
 }
 
 local default_printf_statements = {}