aboutsummaryrefslogtreecommitdiffstats
path: root/src/eval.c
diff options
context:
space:
mode:
authorStefan Monnier2001-12-05 01:39:21 +0000
committerStefan Monnier2001-12-05 01:39:21 +0000
commit162873a199b1dfa5fe2b8686c2204b8cf267f15c (patch)
tree4a75dfc1198fe447a9ccadaf728c69060cd50495 /src/eval.c
parenta01639a36290eb5bcfa791d11e430f0e51b2aade (diff)
downloademacs-162873a199b1dfa5fe2b8686c2204b8cf267f15c.tar.gz
emacs-162873a199b1dfa5fe2b8686c2204b8cf267f15c.zip
Use standard syntax for usage in docstrings.
Diffstat (limited to 'src/eval.c')
-rw-r--r--src/eval.c32
1 files changed, 16 insertions, 16 deletions
diff --git a/src/eval.c b/src/eval.c
index 1378e3cae60..28baf69b31c 100644
--- a/src/eval.c
+++ b/src/eval.c
@@ -286,7 +286,7 @@ DEFUN ("or", For, Sor, 0, UNEVALLED, 0,
286 doc: /* Eval args until one of them yields non-nil, then return that value. 286 doc: /* Eval args until one of them yields non-nil, then return that value.
287The remaining args are not evalled at all. 287The remaining args are not evalled at all.
288If all args return nil, return nil. 288If all args return nil, return nil.
289usage: (or CONDITIONS ...) */) 289usage: (or &rest CONDITIONS) */)
290 (args) 290 (args)
291 Lisp_Object args; 291 Lisp_Object args;
292{ 292{
@@ -317,7 +317,7 @@ DEFUN ("and", Fand, Sand, 0, UNEVALLED, 0,
317 doc: /* Eval args until one of them yields nil, then return nil. 317 doc: /* Eval args until one of them yields nil, then return nil.
318The remaining args are not evalled at all. 318The remaining args are not evalled at all.
319If no arg yields nil, return the last arg's value. 319If no arg yields nil, return the last arg's value.
320usage: (and CONDITIONS ...) */) 320usage: (and &rest CONDITIONS) */)
321 (args) 321 (args)
322 Lisp_Object args; 322 Lisp_Object args;
323{ 323{
@@ -349,7 +349,7 @@ DEFUN ("if", Fif, Sif, 2, UNEVALLED, 0,
349Returns the value of THEN or the value of the last of the ELSE's. 349Returns the value of THEN or the value of the last of the ELSE's.
350THEN must be one expression, but ELSE... can be zero or more expressions. 350THEN must be one expression, but ELSE... can be zero or more expressions.
351If COND yields nil, and there are no ELSE's, the value is nil. 351If COND yields nil, and there are no ELSE's, the value is nil.
352usage: (if COND THEN ELSE...) */) 352usage: (if COND THEN &rest ELSE) */)
353 (args) 353 (args)
354 Lisp_Object args; 354 Lisp_Object args;
355{ 355{
@@ -374,7 +374,7 @@ value is the value of the cond-form.
374If no clause succeeds, cond returns nil. 374If no clause succeeds, cond returns nil.
375If a clause has one element, as in (CONDITION), 375If a clause has one element, as in (CONDITION),
376CONDITION's value if non-nil is returned from the cond-form. 376CONDITION's value if non-nil is returned from the cond-form.
377usage: (cond CLAUSES...) */) 377usage: (cond &rest CLAUSES) */)
378 (args) 378 (args)
379 Lisp_Object args; 379 Lisp_Object args;
380{ 380{
@@ -402,7 +402,7 @@ usage: (cond CLAUSES...) */)
402 402
403DEFUN ("progn", Fprogn, Sprogn, 0, UNEVALLED, 0, 403DEFUN ("progn", Fprogn, Sprogn, 0, UNEVALLED, 0,
404 doc: /* Eval BODY forms sequentially and return value of last one. 404 doc: /* Eval BODY forms sequentially and return value of last one.
405usage: (progn BODY ...) */) 405usage: (progn &rest BODY) */)
406 (args) 406 (args)
407 Lisp_Object args; 407 Lisp_Object args;
408{ 408{
@@ -443,7 +443,7 @@ DEFUN ("prog1", Fprog1, Sprog1, 1, UNEVALLED, 0,
443 doc: /* Eval FIRST and BODY sequentially; value from FIRST. 443 doc: /* Eval FIRST and BODY sequentially; value from FIRST.
444The value of FIRST is saved during the evaluation of the remaining args, 444The value of FIRST is saved during the evaluation of the remaining args,
445whose values are discarded. 445whose values are discarded.
446usage: (prog1 FIRST BODY...) */) 446usage: (prog1 FIRST &rest BODY) */)
447 (args) 447 (args)
448 Lisp_Object args; 448 Lisp_Object args;
449{ 449{
@@ -477,7 +477,7 @@ DEFUN ("prog2", Fprog2, Sprog2, 2, UNEVALLED, 0,
477 doc: /* Eval X, Y and BODY sequentially; value from Y. 477 doc: /* Eval X, Y and BODY sequentially; value from Y.
478The value of Y is saved during the evaluation of the remaining args, 478The value of Y is saved during the evaluation of the remaining args,
479whose values are discarded. 479whose values are discarded.
480usage: (prog2 X Y BODY...) */) 480usage: (prog2 X Y &rest BODY) */)
481 (args) 481 (args)
482 Lisp_Object args; 482 Lisp_Object args;
483{ 483{
@@ -637,7 +637,7 @@ DEFUN ("defun", Fdefun, Sdefun, 2, UNEVALLED, 0,
637 doc: /* Define NAME as a function. 637 doc: /* Define NAME as a function.
638The definition is (lambda ARGLIST [DOCSTRING] BODY...). 638The definition is (lambda ARGLIST [DOCSTRING] BODY...).
639See also the function `interactive'. 639See also the function `interactive'.
640usage: (defun NAME ARGLIST [DOCSTRING] BODY...) */) 640usage: (defun NAME ARGLIST &optional DOCSTRING &rest BODY) */)
641 (args) 641 (args)
642 Lisp_Object args; 642 Lisp_Object args;
643{ 643{
@@ -660,7 +660,7 @@ When the macro is called, as in (NAME ARGS...),
660the function (lambda ARGLIST BODY...) is applied to 660the function (lambda ARGLIST BODY...) is applied to
661the list ARGS... as it appears in the expression, 661the list ARGS... as it appears in the expression,
662and the result should be a form to be evaluated instead of the original. 662and the result should be a form to be evaluated instead of the original.
663usage: (defmacro NAME ARGLIST [DOCSTRING] BODY...) */) 663usage: (defmacro NAME ARGLIST &optional DOCSTRING &rest BODY) */)
664 (args) 664 (args)
665 Lisp_Object args; 665 Lisp_Object args;
666{ 666{
@@ -760,7 +760,7 @@ Always sets the value of SYMBOL to the result of evalling INITVALUE.
760If SYMBOL is buffer-local, its default value is what is set; 760If SYMBOL is buffer-local, its default value is what is set;
761 buffer-local values are not affected. 761 buffer-local values are not affected.
762DOCSTRING is optional. 762DOCSTRING is optional.
763usage: (defconst SYMBOL INITVALUE [DOCSTRING]) */) 763usage: (defconst SYMBOL INITVALUE &optional DOCSTRING) */)
764 (args) 764 (args)
765 Lisp_Object args; 765 Lisp_Object args;
766{ 766{
@@ -826,7 +826,7 @@ The value of the last form in BODY is returned.
826Each element of VARLIST is a symbol (which is bound to nil) 826Each element of VARLIST is a symbol (which is bound to nil)
827or a list (SYMBOL VALUEFORM) (which binds SYMBOL to the value of VALUEFORM). 827or a list (SYMBOL VALUEFORM) (which binds SYMBOL to the value of VALUEFORM).
828Each VALUEFORM can refer to the symbols already bound by this VARLIST. 828Each VALUEFORM can refer to the symbols already bound by this VARLIST.
829usage: (let* VARLIST BODY...) */) 829usage: (let* VARLIST &rest BODY) */)
830 (args) 830 (args)
831 Lisp_Object args; 831 Lisp_Object args;
832{ 832{
@@ -865,7 +865,7 @@ The value of the last form in BODY is returned.
865Each element of VARLIST is a symbol (which is bound to nil) 865Each element of VARLIST is a symbol (which is bound to nil)
866or a list (SYMBOL VALUEFORM) (which binds SYMBOL to the value of VALUEFORM). 866or a list (SYMBOL VALUEFORM) (which binds SYMBOL to the value of VALUEFORM).
867All the VALUEFORMs are evalled before any symbols are bound. 867All the VALUEFORMs are evalled before any symbols are bound.
868usage: (let VARLIST BODY...) */) 868usage: (let VARLIST &rest BODY) */)
869 (args) 869 (args)
870 Lisp_Object args; 870 Lisp_Object args;
871{ 871{
@@ -921,7 +921,7 @@ DEFUN ("while", Fwhile, Swhile, 1, UNEVALLED, 0,
921 doc: /* If TEST yields non-nil, eval BODY... and repeat. 921 doc: /* If TEST yields non-nil, eval BODY... and repeat.
922The order of execution is thus TEST, BODY, TEST, BODY and so on 922The order of execution is thus TEST, BODY, TEST, BODY and so on
923until TEST returns nil. 923until TEST returns nil.
924usage: (while TEST BODY...) */) 924usage: (while TEST &rest BODY) */)
925 (args) 925 (args)
926 Lisp_Object args; 926 Lisp_Object args;
927{ 927{
@@ -1030,7 +1030,7 @@ Then the BODY is executed.
1030Within BODY, (throw TAG) with same tag exits BODY and exits this `catch'. 1030Within BODY, (throw TAG) with same tag exits BODY and exits this `catch'.
1031If no throw happens, `catch' returns the value of the last BODY form. 1031If no throw happens, `catch' returns the value of the last BODY form.
1032If a throw happens, it specifies the value to return from `catch'. 1032If a throw happens, it specifies the value to return from `catch'.
1033usage: (catch TAG BODY...) */) 1033usage: (catch TAG &rest BODY) */)
1034 (args) 1034 (args)
1035 Lisp_Object args; 1035 Lisp_Object args;
1036{ 1036{
@@ -1159,7 +1159,7 @@ DEFUN ("unwind-protect", Funwind_protect, Sunwind_protect, 1, UNEVALLED, 0,
1159If BODYFORM completes normally, its value is returned 1159If BODYFORM completes normally, its value is returned
1160after executing the UNWINDFORMS. 1160after executing the UNWINDFORMS.
1161If BODYFORM exits nonlocally, the UNWINDFORMS are executed anyway. 1161If BODYFORM exits nonlocally, the UNWINDFORMS are executed anyway.
1162usage: (unwind-protect BODYFORM UNWINDFORMS...) */) 1162usage: (unwind-protect BODYFORM &rest UNWINDFORMS) */)
1163 (args) 1163 (args)
1164 Lisp_Object args; 1164 Lisp_Object args;
1165{ 1165{
@@ -1199,7 +1199,7 @@ VAR may be nil; then you do not get access to the signal information.
1199 1199
1200The value of the last BODY form is returned from the condition-case. 1200The value of the last BODY form is returned from the condition-case.
1201See also the function `signal' for more info. 1201See also the function `signal' for more info.
1202usage: (condition-case VAR BODYFORM HANDLERS...) */) 1202usage: (condition-case VAR BODYFORM &rest HANDLERS) */)
1203 (args) 1203 (args)
1204 Lisp_Object args; 1204 Lisp_Object args;
1205{ 1205{