/[emacs]/emacs/lispref/internals.texi
ViewVC logotype

Diff of /emacs/lispref/internals.texi

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1.23 by eliz, Sat Sep 8 17:44:36 2001 UTC revision 1.24 by rms, Sun Dec 23 06:38:58 2001 UTC
# Line 444  appearance.) Line 444  appearance.)
444  @smallexample  @smallexample
445  @group  @group
446  DEFUN ("or", For, Sor, 0, UNEVALLED, 0,  DEFUN ("or", For, Sor, 0, UNEVALLED, 0,
447    "Eval args until one of them yields non-nil; return that value.\n\    doc: /* Eval args until one of them yields non-nil, then return that value.
448  The remaining args are not evalled at all.\n\  The remaining args are not evalled at all.
449    If all args return nil, return nil.
450  @end group  @end group
451  @group  @group
452  If all args return nil, return nil.")  usage: (or CONDITIONS ...)  */)
453    (args)    (args)
454       Lisp_Object args;       Lisp_Object args;
455  @{  @{
# Line 534  called interactively.  A value of @code{ Line 535  called interactively.  A value of @code{
535  should receive no arguments when called interactively.  should receive no arguments when called interactively.
536    
537  @item doc  @item doc
538  This is the documentation string.  It is written just like a  This is the documentation string.  It uses C comment syntax rather
539  documentation string for a function defined in Lisp, except you must  than C string syntax because comment syntax requires nothing special
540  write @samp{\n\} at the end of each line.  In particular, the first line  to include multiple lines.  The @samp{doc:} identifies the comment
541  should be a single sentence.  that follows as the documentation string.  The @samp{/*} and @samp{*/}
542    delimiters that begin and end the comment are not part of the
543    documentation string.
544    
545    If the last line of the documentation string begins with the keyword
546    @samp{usage:}, the rest of the line is treated as the argument list
547    for documentation purposes.  This way, you can use different argument
548    names in the documentation string from the ones used in the C code.
549    
550    All the usual rules for documentation strings in Lisp code
551    (@pxref{Documentation Tips}) apply to C code documentation strings
552    too.
553  @end table  @end table
554    
555    After the call to the @code{DEFUN} macro, you must write the argument    After the call to the @code{DEFUN} macro, you must write the argument

Legend:
Removed from v.1.23  
changed lines
  Added in v.1.24

savannah-hackers-public@gnu.org
ViewVC Help
Powered by ViewVC 1.1.26