doc/common.texi.inc

   1 @c @documentencoding utf-8
   2
   3 @macro Function {args}
   4 @defun \args\
   5 @end defun
   6 @end macro
   7
   8 @macro Macro {args}
   9 @defmac \args\
  10 @end defmac
  11 @end macro
  12
  13 @macro Accessor {args}
  14 @deffn {Accessor} \args\
  15 @end deffn
  16 @end macro
  17
  18 @macro GenericFunction {args}
  19 @deffn {Generic Function} \args\
  20 @end deffn
  21 @end macro
  22
  23 @macro ForeignType {args}
  24 @deftp {Foreign Type} \args\
  25 @end deftp
  26 @end macro
  27
  28 @macro Variable {args}
  29 @defvr {Special Variable} \args\
  30 @end defvr
  31 @end macro
  32
  33 @macro Condition {args}
  34 @deftp {Condition Type} \args\
  35 @end deftp
  36 @end macro
  37
  38 @macro cffi
  39 @acronym{CFFI}
  40 @end macro
  41
  42 @macro impnote {text}
  43 @quotation
  44 @strong{Implementor's note:} @emph{\text\}
  45 @end quotation
  46 @end macro
  47
  48 @c Info "requires" that x-refs end in a period or comma, or ) in the
  49 @c case of @pxref.  So the following implements that requirement for
  50 @c the "See also" subheadings that permeate this manual, but only in
  51 @c Info mode.
  52 @ifinfo
  53 @macro seealso {name}
  54 @ref{\name\}.
  55 @end macro
  56 @end ifinfo
  57
  58 @ifnotinfo
  59 @alias seealso = ref
  60 @end ifnotinfo
  61
  62 @c Typeset comments in roman font for the TeX output.
  63 @iftex
  64 @alias lispcmt = r
  65 @end iftex
  66 @ifnottex
  67 @alias lispcmt = asis
  68 @end ifnottex
  69
  70 @c My copy of makeinfo is not generating any HTML for @result{} for
  71 @c some odd reason. (It certainly used to...)
  72 @ifhtml
  73 @macro result
  74 =>
  75 @end macro
  76 @end ifhtml
  77
  78 @c Similar macro to @result. Its purpose is to work around the fact
  79 @c that &rArr; does not work properly inside @lisp.
  80 @ifhtml
  81 @macro res
  82 @html
  83 &rArr;
  84 @end html
  85 @end macro
  86 @end ifhtml
  87
  88 @ifnothtml
  89 @alias res = result
  90 @end ifnothtml
  91
  92 @c ============================= Macros =============================
  93
  94
  95 @c Show types, functions, and concepts in the same index.
  96 @syncodeindex tp cp
  97 @syncodeindex fn cp