[WIP]: Thu 13 Aug 2020 10:49:21 PM EDT

lua/docs.lua

@@ -247,6 +247,28 @@ function docs.test()
   print(vim.inspect(t))
 end
 
+local text_width = 78
+function docs.transform_function(name, metadata)
+end
+
+--[[
+ ["M.example"] = {
+    description = "--- Example function",
+    parameters = {
+      a = {
+        description = { "This is a number" },
+        name = "a",
+        type = "number"
+      },
+      b = {
+        description = { "Also a number" },
+        name = "b",
+        type = "number"
+      }
+    }
+  }
+--]]
+
 
 vim.cmd [[nnoremap asdf :lua package.loaded['docs'] = nil; require('docs').test()<CR>]]
 

query/lua/_test.scm

@@ -1,2 +1,5 @@
-(function_statement (emmy_documentation)) @func
-(variable_declaration (emmy_documentation)) @var
+(function_statement
+  documentation: (emmy_documentation)) @func
+
+(variable_declaration
+  documentation: (emmy_documentation)) @var

scratch/module_example.lua

@@ -24,11 +24,12 @@ end
 M.not_documented = function()
 end
 
-local NotExported = {}
+-- TODO: Figure out how to exclude the not exported stuff.
+--local NotExported = {}
 
---- Should not get exported
----@param wow string: Yup
-function NotExported.not_exported()
-end
+----- Should not get exported
+-----@param wow string: Yup
+--NotExported.not_exported = function()
+--end
 
 return M