diff options
Diffstat (limited to '')
| -rw-r--r-- | stdlib/source/documentation/lux/ffi.jvm.lux | 42 |
1 files changed, 21 insertions, 21 deletions
diff --git a/stdlib/source/documentation/lux/ffi.jvm.lux b/stdlib/source/documentation/lux/ffi.jvm.lux index e095e8a15..9e5d1e31c 100644 --- a/stdlib/source/documentation/lux/ffi.jvm.lux +++ b/stdlib/source/documentation/lux/ffi.jvm.lux @@ -24,7 +24,7 @@ ($.default /.cannot_cast_to_non_object) (,, (with_template [<name>] - [(`` ($.documentation <name> + [(`` ($.definition <name> (format "The type of a (boxed) " (,, (template.text [<name>])) " object.")))] [/.Boolean] @@ -38,7 +38,7 @@ )) (,, (with_template [<name>] - [(`` ($.documentation <name> + [(`` ($.definition <name> (format "The type of an (unboxed) " (,, (template.text [<name>])) " value.")))] [/.boolean] @@ -52,7 +52,7 @@ )) (,, (with_template [<name> <from> <to>] - [(`` ($.documentation <name> + [(`` ($.definition <name> "Type converter."))] [/.byte_to_long Byte Long] @@ -92,7 +92,7 @@ [/.short_to_char Short Character] )) - ($.documentation /.class + ($.definition /.class "Allows defining JVM classes in Lux code." [(class "final" (TestClass A) [Runnable] ... Fields @@ -123,12 +123,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." @@ -141,25 +141,25 @@ (do_something some_value) [])))]) - ($.documentation /.null + ($.definition /.null "The null pointer." [(null)]) - ($.documentation /.null? + ($.definition /.null? "Test for the null pointer." [(= true (null? (null)))] [(= false (null? "YOLO"))]) - ($.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 /.!!! (format "Takes a (Maybe ObjectType) and returns a ObjectType." \n "A .#None would get translated into a (null).") [(= (null) @@ -167,14 +167,14 @@ [(= "foo" (!!! (??? "foo")))]) - ($.documentation /.as + ($.definition /.as (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 (as 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 @@ -182,13 +182,13 @@ (dosomething else) (finish the computation)))]) - ($.documentation /.to + ($.definition /.to "Call a variety of methods on an object. Then, return the object." [(to object (ClassName::method1 arg0 arg1 arg2) (ClassName::method2 arg3 arg4 arg5))]) - ($.documentation /.import + ($.definition /.import "Allows importing JVM classes, and using them as types." ["Their methods, fields and enum options can also be imported." (import java/lang/Object @@ -236,32 +236,32 @@ (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." [(class_for java/lang/String)]) - ($.documentation /.type + ($.definition /.type "" [(is Type (type java/lang/String))]) - ($.documentation /.is + ($.definition /.is "" [(is java/lang/Object (is java/lang/String |