summaryrefslogtreecommitdiff
path: root/Lisp
diff options
context:
space:
mode:
authorMatthias Benkard <code@mail.matthias.benkard.de>2007-09-21 19:47:22 +0200
committerMatthias Benkard <code@mail.matthias.benkard.de>2007-09-21 19:47:22 +0200
commite8081745f009f2f7c3dc9b46d072094e6bab30d6 (patch)
treec9f2dcc62a61edafefdb4f4ad2f5dbfe596c6309 /Lisp
parent131f41186f41a41dbad6e7e1bce0320af2b74f72 (diff)
Improve method invocation docstrings.
darcs-hash:97cbabf4e3fb9b9832ca798b01d571c3d8b56778
Diffstat (limited to 'Lisp')
-rw-r--r--Lisp/method-invocation.lisp23
1 files changed, 20 insertions, 3 deletions
diff --git a/Lisp/method-invocation.lisp b/Lisp/method-invocation.lisp
index c66661c..83fead1 100644
--- a/Lisp/method-invocation.lisp
+++ b/Lisp/method-invocation.lisp
@@ -44,7 +44,7 @@ if as the second **argument** to __invoke-by-name__.
## Examples:
(invoke (find-objc-class 'ns-string)
- :string-with-c-string \"Mulk.\")
+ :string-with-u-t-f-8-string \"Mulk.\")
;=> #<GSCBufferString `Mulk.' {5B36087}>
(invoke (find-objc-class 'ns-object)
@@ -77,17 +77,25 @@ if as the second **argument** to __invoke-by-name__.
*receiver* --- an Objective C wrapper object.
-*method-name* --- a **string**.
+*method-name* --- a *selector designator*.
*args* --- a list of **object**s.
Returns: *result* --- the return value of the method invocation.
+## Description:
+
+__invoke-by-name__ is like __invoke__ except in its syntax. It sends
+the message whose selector is designated by *method-name*, which must be
+either a *string*, a *symbol*, a list of message name components as in a
+call to __invoke__, or an object of *type* __selector__, to *receiver*.
+
+
## Examples:
(invoke-by-name (find-objc-class 'ns-string)
- \"stringWithCString:\" \"Mulk.\")
+ '(:string-with-u-t-f-8-string) \"Mulk.\")
;=> #<GSCBufferString `Mulk.' {5B36087}>
(invoke-by-name (find-objc-class 'ns-object)
@@ -101,6 +109,15 @@ Returns: *result* --- the return value of the method invocation.
;=> #<GSCBufferString `Mulk.' {5B36087}>
+## Rationale:
+
+Whereas __invoke__ tries to make writing as well as reading method
+invocations easy by interspersing method name components with arguments
+as Objective-C does, __invoke-by-name__ is better suited for method
+selection at run time as well as code generation. It is also slightly
+easier to use with __apply__.
+
+
## See also:
__invoke__"