Improved documentation strings in ffi.lsp

This commit is contained in:
Juan Jose Garcia Ripoll 2010-02-19 20:11:49 +01:00
parent 3fdd435f28
commit 5b88df9fe5

View file

@ -706,7 +706,7 @@
(list (list ,@args) ',arg-types ',ret-type ,@others))))
(defmacro definline (fun arg-types type code)
"Syntax: (definline symbol ({arg-type}*) value-type body)" "
"Syntax: (definline symbol (&rest arg-types) result-type &body body) " "
DEFINLINE behaves like a DEFCBODY (see), but also instructs the LISP compiler
to expand inline any call to function SYMBOL into code corresponding
@ -719,7 +719,7 @@ the actual arguments are of the specified type."
(def-inline ,fun :always ,arg-types ,type ,code)))
(defmacro defla (&rest body)
"Syntax: (defla name lambda-list {decl | doc}* {form}*)" "
"Syntax: (defla name lambda-list &body body)" "
Used to DEFine Lisp Alternative. For the interpreter, DEFLA is equivalent to
DEFUN, but the compiler ignores this form."
@ -727,7 +727,7 @@ DEFUN, but the compiler ignores this form."
(defun ,@body)))
(defmacro defcbody (name arg-types result-type C-expr)
"Syntax: (defcbody symbol ({arg-type}*) value-type body)" "
"Syntax: (defcbody symbol (&rest arg-types) result-type &body body)" "
The compiler defines a Lisp function named by SYMBOL whose body consists of the
C code of the string BODY. In the BODY one can reference the arguments of the
@ -740,7 +740,7 @@ defined Lisp function and VALUE-TYPE is its the return type."
,C-expr :one-liner t))))
(defmacro defentry (name arg-types c-name &key no-interrupts)
"Syntax: (defentry symbol ({arg-type}*) (value-type function-name))
"Syntax: (defentry symbol (&rest arg-types*) (result-type function-name))
The compiler defines a Lisp function named by SYMBOL whose body consists of a
calling sequence to the C language function named by FUNCTION-NAME. The