docs: docgen using nix

Author: boltlessengineer

Makefile

@@ -1,4 +1,4 @@
-.PHONY: lint format test docgen
+.PHONY: lint format test docgen doc
 .SILENT: docgen
 
 lint:
@@ -11,10 +11,3 @@ test:
 	LUA_PATH="$(shell luarocks path --lr-path --lua-version 5.1 --local)" \
 	LUA_CPATH="$(shell luarocks path --lr-cpath --lua-version 5.1 --local)" \
 	luarocks test --local --lua-version 5.1
-
-docgen:
-	lemmy-help lua/rest-nvim/commands.lua > doc/rest-nvim-commands.txt
-	lemmy-help lua/rest-nvim/config/init.lua > doc/rest-nvim-config.txt
-	lemmy-help lua/rest-nvim/cookie_jar.lua > doc/rest-nvim-cookies.txt
-	lemmy-help lua/rest-nvim/api.lua lua/rest-nvim/client/init.lua lua/rest-nvim/script/init.lua lua/rest-nvim/ui/result.lua lua/rest-nvim/utils.lua > doc/rest-nvim-api.txt
-	lemmy-help lua/rest-nvim/client/curl/cli.lua lua/rest-nvim/client/curl/utils.lua > doc/rest-nvim-client-curl.txt

doc/rest-nvim-api.txt

@@ -45,25 +45,32 @@ api.register_rest_subcommand({name}, {cmd})
         {cmd}   (RestCmd)
 
 
+api.register_rest_client()                            *api.register_rest_client*
+
+
 ==============================================================================
 rest.nvim client module                                       *rest-nvim.client*
 
+rest.Client                                                        *rest.Client*
+    Client to send request
 
- Mainly about `rest.Client` type requirements
+    Fields: ~
+        {name}       (string)                                    name of the client
+        {request}    (fun(req:rest.Request):nio.control.Future)  Sends request and return the response asynchronously
+        {available}  (fun(req:rest.Request):boolean)             Check if client can handle given request
 
 
-rest.Client                                                        *rest.Client*
-    Client to send request
+clients.register_client()                              *clients.register_client*
 
 
-client:request({req})                                           *client:request*
-    Sends request and return the response asynchronously
+clients.get_available_clients({req})             *clients.get_available_clients*
+    Find all registered clients available for given request
 
     Parameters: ~
         {req}  (rest.Request)
 
     Returns: ~
-        (nio.control.Future)  Future containing `rest.Response`
+        (rest.Client[])
 
 
 ==============================================================================
@@ -77,60 +84,56 @@ script runner client for rest.nvim                            *rest-nvim.script*
 rest.ScriptClient                                            *rest.ScriptClient*
 
 
-script:load_pre_req_hook({str}, {ctx})                *script:load_pre_req_hook*
+script.load_pre_req_hook({str}, {ctx})                *script.load_pre_req_hook*
 
     Parameters: ~
         {str}  (string)
         {ctx}  (rest.Context)
 
 
-script:load_post_req_hook({str}, {ctx})              *script:load_post_req_hook*
+script.load_post_req_hook({str}, {ctx})              *script.load_post_req_hook*
 
     Parameters: ~
         {str}  (string)
         {ctx}  (rest.Context)
 
 
 ==============================================================================
-rest.nvim result UI module                                 *rest-nvim.ui.result*
+Cookie handler module                                     *rest-nvim.cookie_jar*
 
+rest.Cookie                                                        *rest.Cookie*
 
- rest.nvim result UI implmentation
+    Fields: ~
+        {name}      (string)
+        {value}     (string)
+        {domain}    (string)
+        {path}      (string)
+        {expires}   (integer)
+        {max_date}  (integer)
 
 
-rest.UIData                                                        *rest.UIData*
-    data used to render the UI
-
-
-ui.stat_winbar()                                                *ui.stat_winbar*
-    Winbar component showing response statistics
-
-    Returns: ~
-        (string)
+M.load_jar()                                                        *M.load_jar*
+    Load Cookie jar from rest-nvim.cookies file
 
 
-ui.is_open()                                                        *ui.is_open*
-    Check if UI window is shown in current tabpage
-
-    Returns: ~
-        (boolean)
-
-
-ui.enter({winnr})                                                     *ui.enter*
+M.update_jar({req_url}, {res})                                    *M.update_jar*
+    Save cookies from response
+    Request is provided as a context
 
     Parameters: ~
-        {winnr}  (integer)
+        {req_url}  (string)
+        {res}      (rest.Response)
 
 
-ui.clear()                                                            *ui.clear*
-    Clear the UI
+M.save_jar()                                                        *M.save_jar*
+    Save current cookie jar to cookies file
 
 
-ui.update({new_data})                                                *ui.update*
-    Update data and rerender the UI
+M.load_cookies({req})                                           *M.load_cookies*
+    Load cookies for request
 
     Parameters: ~
-        {new_data}  (rest.UIData)
+        {req}  (rest.Request)
 
 
 ==============================================================================
@@ -245,4 +248,44 @@ utils.nvim_lazy_set_wo({bufnr}, {name}, {value})
         {value}  (any)
 
 
+utils.gq_lines({lines}, {filetype})                             *utils.gq_lines*
+    format lines using native vim `gq` command
+
+    Parameters: ~
+        {lines}     (string[])
+        {filetype}  (string)
+
+    Returns: ~
+        (string[])
+
+
+==============================================================================
+rest.nvim logger                                              *rest-nvim.logger*
+
+
+Logging library for rest.nvim, inspired by nvim-neorocks/rocks.nvim
+Intended for use by internal and third-party modules.
+
+
+logger.trace()                                                    *logger.trace*
+
+
+logger.debug()                                                    *logger.debug*
+
+
+logger.info()                                                      *logger.info*
+
+
+logger.warn()                                                      *logger.warn*
+
+
+logger.error()                                                    *logger.error*
+
+
+logger.set_log_level()                                    *logger.set_log_level*
+
+    See: ~
+        |vim.log.levels|
+
+
 vim:tw=78:ts=8:noet:ft=help:norl: