aboutsummaryrefslogtreecommitdiffstats
path: root/core/init.moon
diff options
context:
space:
mode:
authors-ol <s-ol@users.noreply.github.com>2020-03-07 20:58:30 +0000
committers-ol <s-ol@users.noreply.github.com>2020-03-07 20:58:51 +0000
commit6a7a2ddaca798f3cccac394d1fb9f317cbe90de6 (patch)
tree4e49e53057b39f75813311ede13f87d238061fe6 /core/init.moon
parentspellcheck (diff)
downloadalive-6a7a2ddaca798f3cccac394d1fb9f317cbe90de6.tar.gz
alive-6a7a2ddaca798f3cccac394d1fb9f317cbe90de6.zip
add ldoc documentation
Diffstat (limited to 'core/init.moon')
-rw-r--r--core/init.moon27
1 files changed, 26 insertions, 1 deletions
diff --git a/core/init.moon b/core/init.moon
index 7122e0f..c4e8ffd 100644
--- a/core/init.moon
+++ b/core/init.moon
@@ -1,3 +1,17 @@
+----
+-- `alive` public API.
+--
+-- @see Value
+-- @see Result
+-- @see Cell
+-- @see Scope
+-- @see Registry
+-- @see Tag
+-- @field globals
+-- @field parse
+-- @field eval
+--
+-- @module init
L or= setmetatable {}, __index: => ->
import Value from require 'core.value'
@@ -6,7 +20,7 @@ import Scope from require 'core.scope'
import Registry from require 'core.registry'
import Tag from require 'core.tag'
-import Cell, RootCell from require 'core.cell'
+import Cell from require 'core.cell'
import cell, program from require 'core.parsing'
with require 'core.cycle'
@@ -14,6 +28,17 @@ with require 'core.cycle'
globals = Scope.from_table require 'core.builtin'
+--- exports
+-- @table exports
+-- @tfield Value Value
+-- @tfield Result Result
+-- @tfield Cell Cell
+-- @tfield RootCell RootCell
+-- @tfield Scope Scope
+-- @tfield Registry Registry
+-- @tfield Tag Tag
+-- @tfield Scope globals global definitons
+-- @tfield parse function to turn a `string` into a root `Cell`
{
:Value, :Result
:Cell, :RootCell