aboutsummaryrefslogtreecommitdiff
path: root/stdlib/source/documentation/lux/ffi.lua.lux
blob: 9f11805e81fa17c88ddc039f5e71ec781e5a4a86 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
(.require
 [library
  [lux (.except)
   ["$" documentation]
   [data
    ["[0]" text (.only \n)
     ["%" \\format (.only format)]]]]]
 [\\library
  ["[0]" /]])

(def .public documentation
  (List $.Documentation)
  (list ($.module /._
                  "")

        ($.definition (/.Object brand))
        ($.definition /.Nil)
        ($.definition /.Function)
        ($.definition /.Table)
        ($.definition /.Boolean)
        ($.definition /.Integer)
        ($.definition /.Float)
        ($.definition /.String)

        ($.definition /.import
          "Easily import types, methods, functions and constants."
          ($.example (import (os/getenv [..String] "io" "?" ..String))))

        ($.definition /.function
          (format "Allows defining closures/anonymous-functions in the form that Lua expects."
                  \n "This is useful for adapting Lux functions for usage by Lua code.")
          ($.example (is ..Function
                         (function [left right]
                           (do_something (as Foo left) (as Bar right))))))
        ))