aboutsummaryrefslogtreecommitdiff
path: root/stdlib/source/documentation/lux/ffi.old.lux
diff options
context:
space:
mode:
authorEduardo Julian2022-07-08 17:47:23 -0400
committerEduardo Julian2022-07-08 17:47:23 -0400
commit7976268575e7c6910dfba2d2733e8cc1883678e7 (patch)
tree0ce156081612235c0df5e2ad9167be3fc5d75c6c /stdlib/source/documentation/lux/ffi.old.lux
parent39325bb36c6f6459c861ef12f9e99b9e66b52594 (diff)
Re-named the "documentation" macro to "definition".
Diffstat (limited to '')
-rw-r--r--stdlib/source/documentation/lux/ffi.old.lux36
1 files changed, 18 insertions, 18 deletions
diff --git a/stdlib/source/documentation/lux/ffi.old.lux b/stdlib/source/documentation/lux/ffi.old.lux
index e0e667494..eb4b5b8fe 100644
--- a/stdlib/source/documentation/lux/ffi.old.lux
+++ b/stdlib/source/documentation/lux/ffi.old.lux
@@ -17,7 +17,7 @@
($.default /.Inheritance)
(,, (with_template [<name> <from> <to>]
- [($.documentation <name>
+ [($.definition <name>
"Type converter.")]
[/.byte_to_long "java.lang.Byte" "java.lang.Long"]
@@ -51,7 +51,7 @@
[/.char_to_long "java.lang.Character" "java.lang.Long"]
))
- ($.documentation /.class
+ ($.definition /.class
"Allows defining JVM classes in Lux code."
[(class "final" (TestClass A) [Runnable]
... Fields
@@ -80,12 +80,12 @@
"(::new! []) for calling the class's constructor."
"(::resolve! container [value]) for calling the 'resolve' method."])
- ($.documentation /.interface
+ ($.definition /.interface
"Allows defining JVM interfaces."
[(interface TestInterface
([] foo [boolean String] void "throws" [Exception]))])
- ($.documentation /.object
+ ($.definition /.object
"Allows defining anonymous classes."
["The 1st tuple corresponds to class-level type-variables."
"The 2nd tuple corresponds to parent interfaces."
@@ -97,25 +97,25 @@
(exec (do_something some_value)
[])))])
- ($.documentation /.null
+ ($.definition /.null
"Null object reference."
(null))
- ($.documentation /.null?
+ ($.definition /.null?
"Test for null object reference."
[(= (null? (null))
true)]
[(= (null? "YOLO")
false)])
- ($.documentation /.???
+ ($.definition /.???
"Takes a (potentially null) ObjectType reference and creates a (Maybe ObjectType) for it."
[(= (??? (is java/lang/String (null)))
{.#None})]
[(= (??? "YOLO")
{.#Some "YOLO"})])
- ($.documentation /.!!!
+ ($.definition /.!!!
"Takes a (Maybe ObjectType) and returns a ObjectType."
[(= "foo"
(!!! (??? "foo")))]
@@ -123,14 +123,14 @@
(= (null)
(!!! (??? (is java/lang/Thread (null)))))])
- ($.documentation /.check
+ ($.definition /.check
(format "Checks whether an object is an instance of a particular class."
\n "Caveat emptor: Cannot check for polymorphism, so avoid using parameterized classes.")
[(case (check java/lang/String "YOLO")
{.#Some value_as_string}
{.#None})])
- ($.documentation /.synchronized
+ ($.definition /.synchronized
"Evaluates body, while holding a lock on a given object."
[(synchronized object_to_be_locked
(exec
@@ -138,13 +138,13 @@
(do_something else)
(finish the computation)))])
- ($.documentation /.to
+ ($.definition /.to
"Call a variety of methods on an object. Then, return the object."
[(to object
(ClassName::method0 arg0 arg1 arg2)
(ClassName::method1 arg3 arg4 arg5))])
- ($.documentation /.import
+ ($.definition /.import
(format "Allows importing JVM classes, and using them as types."
\n "Their methods, fields and enum options can also be imported.")
[(import java/lang/Object
@@ -192,28 +192,28 @@
(java/util/List::size [] my_list)
java/lang/Character$UnicodeScript::LATIN])
- ($.documentation /.array
+ ($.definition /.array
"Create an array of the given type, with the given size."
[(array java/lang/Object 10)])
- ($.documentation /.length
+ ($.definition /.length
"Gives the length of an array."
[(length my_array)])
- ($.documentation /.read!
+ ($.definition /.read!
"Loads an element from an array."
[(read! 10 my_array)])
- ($.documentation /.write!
+ ($.definition /.write!
"Stores an element into an array."
[(write! 10 my_object my_array)])
- ($.documentation /.class_for
+ ($.definition /.class_for
"Loads the class as a java.lang.Class object."
[(is (Primitive "java.lang.Class" ["java.lang.Object"])
(class_for java/lang/String))])
- ($.documentation /.type
+ ($.definition /.type
""
[(is .Type
(type java/lang/String))])]