]> gitweb.factorcode.org Git - factor.git/commitdiff
cocoa.apple-script: adding some docs.
authorJohn Benediktsson <mrjbq7@gmail.com>
Fri, 11 Oct 2013 15:25:11 +0000 (08:25 -0700)
committerJohn Benediktsson <mrjbq7@gmail.com>
Fri, 11 Oct 2013 15:25:11 +0000 (08:25 -0700)
basis/cocoa/apple-script/apple-script-docs.factor [new file with mode: 0644]
basis/cocoa/apple-script/authors.txt [new file with mode: 0644]

diff --git a/basis/cocoa/apple-script/apple-script-docs.factor b/basis/cocoa/apple-script/apple-script-docs.factor
new file mode 100644 (file)
index 0000000..2a2de90
--- /dev/null
@@ -0,0 +1,13 @@
+USING: help.markup help.syntax strings ;
+
+IN: cocoa.apple-script
+
+HELP: run-apple-script
+{ $values { "str" string } }
+{ $description "Runs the provided uncompiled AppleScript code." }
+{ $notes "Currently, return values are unsupported." } ;
+
+HELP: APPLESCRIPT:
+{ $syntax "APPLESCRIPT: word ...applescript... ;APPLESCRIPT" }
+{ $values { "word" "a word" } { "...applescript..." "AppleScript source text" } }
+{ $description "Defines a word that when called will run the provided uncompiled AppleScript.  The word has stack effect " { $snippet "( -- )" } " due to return values being currently unsupported." } ;
diff --git a/basis/cocoa/apple-script/authors.txt b/basis/cocoa/apple-script/authors.txt
new file mode 100644 (file)
index 0000000..e091bb8
--- /dev/null
@@ -0,0 +1 @@
+John Benediktsson