tools/cxref/README.c.rtf

   1 {\rtf\ansi
   2 \deff0
   3 {\fonttbl
   4 {\f0\froman Times New Roman;}
   5 {\f1\fmodern Courier New;}
   6 }
   7 {\stylesheet
   8 {\s0\f0\fs24 Normal;}
   9 {\s1\f0\fs40\b\sb400\sa200\keepn\keep Heading 1;}
  10 {\s2\f0\fs32\b\sb200\sa100\keepn\keep Heading 2;}
  11 {\s3\f0\fs28\b\sb100\sa100\keepn\keep Heading 3;}
  12 {\s4\f0\fs24\b\sb100\sa50\keepn\keep Heading 4;}
  13 {\s5\f1\fs20\ql\sb50\sa50 Code;}
  14 }
  15 {\info{\comment This RTF file generated by cxref. cxref program (c) Andrew M. Bishop 1995,96,97,98,99.}}
  16 \paperw11880\paperh16848\margl1440\margr1440\margt1440\margb1440
  17 \sectd\plain
  18 \s0\f0\fs24
  19 {\s1\f0\fs40\b\sb400\sa200\keepn\keep File README.c\par}
  20 {\b RCS Header: /home/amb/cxref/RCS/README.c 1.4 1997/05/26 11:23:40 amb Exp}\par
  21 A comment for the file, RCS header comments are treated specially when first.\par
  22 {\s2\f0\fs32\b\sb200\sa100\keepn\keep Included Files\par}
  23 A #include comment\par
  24 {\s5\f1\fs20\ql\sb50\sa50 #include <stdio.h>\par}
  25 An alternative #include comment.\par
  26 {\s5\f1\fs20\ql\sb50\sa50 #include <math.h>\par}
  27 {\s2\f0\fs32\b\sb200\sa100\keepn\keep Preprocessor definitions\par}
  28 A #define comment.\par
  29 {\s5\f1\fs20\ql\sb50\sa50 #define def1 1\par}
  30 An alternative #define comment.\par
  31 {\s5\f1\fs20\ql\sb50\sa50 #define def2 2\par}
  32 A #define with args\par
  33 {\s5\f1\fs20\ql\sb50\sa50 #define def3( arg1, arg2 )\par}
  34 {\s5\f1\fs20\ql\sb50\sa50arg1\par}
  35 {\s6\f0\fs24\ql\li720 The first arg\par}
  36 {\s5\f1\fs20\ql\sb50\sa50arg2\par}
  37 {\s6\f0\fs24\ql\li720 The second arg\par}
  38 An alternative #define with args.\par
  39 {\s5\f1\fs20\ql\sb50\sa50 #define def4( arg1, arg2 )\par}
  40 {\s5\f1\fs20\ql\sb50\sa50arg1\par}
  41 {\s6\f0\fs24\ql\li720 The first arg\par}
  42 {\s5\f1\fs20\ql\sb50\sa50arg2\par}
  43 {\s6\f0\fs24\ql\li720 The second arg\par}
  44 {\s2\f0\fs32\b\sb200\sa100\keepn\keep Type definitions\par}
  45 {\s3\f0\fs28\b\sb100\sa100\keepn\keep Typedef type1\par}
  46 An example typedef comment\par
  47 {\s5\f1\fs20\ql\sb50\sa50 typedef enum \{...\} type1\par}
  48 \trowd\trgaph120\cellx2880\cellx9000
  49 \intbl\plain
  50 {\s5\f1\fs20\ql\sb50\sa50 enum}\cell\cell\row
  51 {\s5\f1\fs20\ql\sb50\sa50 \{}\cell\cell\row
  52         {\s5\f1\fs20\ql\sb50\sa50 one;}\cell one value\cell\row
  53         {\s5\f1\fs20\ql\sb50\sa50 two;}\cell another value\cell\row
  54 {\s5\f1\fs20\ql\sb50\sa50 \}}\cell\cell\row
  55 \intbl0
  56 {\s3\f0\fs28\b\sb100\sa100\keepn\keep Type union bar\par}
  57 Nested structs and unions also work.\par
  58 \trowd\trgaph120\cellx2880\cellx9000
  59 \intbl\plain
  60 {\s5\f1\fs20\ql\sb50\sa50 union bar}\cell\cell\row
  61 {\s5\f1\fs20\ql\sb50\sa50 \{}\cell\cell\row
  62         {\s5\f1\fs20\ql\sb50\sa50 char a;}\cell Each element\cell\row
  63         {\s5\f1\fs20\ql\sb50\sa50 int b;}\cell of a struct\cell\row
  64         {\s5\f1\fs20\ql\sb50\sa50 int c;}\cell or a union\cell\row
  65         {\s5\f1\fs20\ql\sb50\sa50 long d;}\cell can have a comment\cell\row
  66 {\s5\f1\fs20\ql\sb50\sa50 \}}\cell\cell\row
  67 \intbl0
  68 {\s3\f0\fs28\b\sb100\sa100\keepn\keep Typedef type2\par}
  69 Another example typedef comment, a type that is a struct.\par
  70 {\s5\f1\fs20\ql\sb50\sa50 typedef struct \{...\} type2\par}
  71 \trowd\trgaph120\cellx2880\cellx9000
  72 \intbl\plain
  73 {\s5\f1\fs20\ql\sb50\sa50 struct}\cell\cell\row
  74 {\s5\f1\fs20\ql\sb50\sa50 \{}\cell\cell\row
  75         {\s5\f1\fs20\ql\sb50\sa50 int a;}\cell A variable in a struct.\cell\row
  76         {\s5\f1\fs20\ql\sb50\sa50 union bar}\cell\cell\row
  77         {\s5\f1\fs20\ql\sb50\sa50 \{}\cell\cell\row
  78                 {\s5\f1\fs20\ql\sb50\sa50 char a;}\cell Each element\cell\row
  79                 {\s5\f1\fs20\ql\sb50\sa50 int b;}\cell of a struct\cell\row
  80                 {\s5\f1\fs20\ql\sb50\sa50 int c;}\cell or a union\cell\row
  81                 {\s5\f1\fs20\ql\sb50\sa50 long d;}\cell can have a comment\cell\row
  82         {\s5\f1\fs20\ql\sb50\sa50 \}}\cell\cell\row
  83         {\s5\f1\fs20\ql\sb50\sa50 e;}\cell Nested structs and unions also work.\par
  84 {\s5\f1\fs20\ql\sb50\sa50 \}}\cell\cell\row
  85 \intbl0
  86 {\s3\f0\fs28\b\sb100\sa100\keepn\keep Typedef ptype2\par}
  87 Another example typedef comment, a pointer to a struct type.\par
  88 {\s5\f1\fs20\ql\sb50\sa50 typedef struct \{...\}* ptype2\par}
  89 See:    Typedef type2\par
  90 {\s2\f0\fs32\b\sb200\sa100\keepn\keep Variables\par}
  91 {\s3\f0\fs28\b\sb100\sa100\keepn\keep Variable var1\par}
  92 A leading comment only.\par
  93 {\s5\f1\fs20\ql\sb50\sa50 int var1\par}
  94 \trowd\trgaph120\cellx1440\cellx5220\cellx9000
  95 \intbl\plain
  96 Visible in:\cell README.c\cell\cell\row
  97 Used in:\cell function1()\cell README.c\cell\row
  98 \intbl0
  99 {\s3\f0\fs28\b\sb100\sa100\keepn\keep Variable var2\par}
 100 A leading comment only.\par
 101 {\s5\f1\fs20\ql\sb50\sa50 int var2\par}
 102 \trowd\trgaph120\cellx1440\cellx5220\cellx9000
 103 \intbl\plain
 104 Visible in:\cell README.c\cell\cell\row
 105 \intbl0
 106 {\s3\f0\fs28\b\sb100\sa100\keepn\keep Variable var4\par}
 107 A variable for one thing.\par
 108 {\s5\f1\fs20\ql\sb50\sa50 int var4\par}
 109 \trowd\trgaph120\cellx1440\cellx5220\cellx9000
 110 \intbl\plain
 111 Visible in:\cell README.c\cell\cell\row
 112 Used in:\cell function1()\cell README.c\cell\row
 113 \intbl0
 114 {\s3\f0\fs28\b\sb100\sa100\keepn\keep Variable var5\par}
 115 A variable for a second thing.\par
 116 {\s5\f1\fs20\ql\sb50\sa50 int var5\par}
 117 \trowd\trgaph120\cellx1440\cellx5220\cellx9000
 118 \intbl\plain
 119 Visible in:\cell README.c\cell\cell\row
 120 \intbl0
 121 {\s3\f0\fs28\b\sb100\sa100\keepn\keep Variable var6\par}
 122 A variable for a third thing.\par
 123 {\s5\f1\fs20\ql\sb50\sa50 int var6\par}
 124 \trowd\trgaph120\cellx1440\cellx5220\cellx9000
 125 \intbl\plain
 126 Visible in:\cell README.c\cell\cell\row
 127 \intbl0
 128 {\s3\f0\fs28\b\sb100\sa100\keepn\keep Local Variables\par}
 129 {\s4\f0\fs24\b\sb100\sa50\keepn\keep Variable var3\par}
 130 A trailing comment only.\par
 131 {\s5\f1\fs20\ql\sb50\sa50 static int var3\par}
 132 \trowd\trgaph120\cellx1440\cellx5220\cellx9000
 133 \intbl\plain
 134 Used in:\cell function1()\cell\cell\row
 135 \intbl0
 136 {\s2\f0\fs32\b\sb200\sa100\keepn\keep Functions\par}
 137 {\s3\f0\fs28\b\sb100\sa100\keepn\keep Global Function function1()\par}
 138 A function comment (the comments for the args need to be separated by a blank line). Some more comments An internal comment in a function that appears as a new paragraph at the end of the comment.\par
 139 {\s5\f1\fs20\ql\sb50\sa50 int function1 ( int arg1, int arg2 )\par}
 140 {\s5\f1\fs20\ql\sb50\sa50 int function1\par}
 141 {\s6\f0\fs24\ql\li720 The return value.\par}
 142 {\s5\f1\fs20\ql\sb50\sa50 int arg1\par}
 143 {\s6\f0\fs24\ql\li720 The first argument.\par}
 144 {\s5\f1\fs20\ql\sb50\sa50 int arg2\par}
 145 {\s6\f0\fs24\ql\li720 The second argument.\par}
 146 \trowd\trgaph120\cellx1440\cellx5220\cellx9000
 147 \intbl\plain
 148 Calls: \cell function2()\cell README.c\cell\row
 149 Used in:\cell function2()\cell README.c\cell\row
 150 Refs Var:\cell var1\cell README.c\cell\row
 151 \cell var3\cell README.c\cell\row
 152 \cell var4\cell README.c\cell\row
 153 \intbl0
 154 {\s3\f0\fs28\b\sb100\sa100\keepn\keep Global Function function2()\par}
 155 An alternative function comment\par
 156 {\s5\f1\fs20\ql\sb50\sa50 int function2 ( int arg1, int arg2, void )\par}
 157 {\s5\f1\fs20\ql\sb50\sa50 int function2\par}
 158 {\s6\f0\fs24\ql\li720 Returns a value\par}
 159 {\s5\f1\fs20\ql\sb50\sa50 int arg1\par}
 160 {\s6\f0\fs24\ql\li720 The first argument.\par}
 161 {\s5\f1\fs20\ql\sb50\sa50 int arg2\par}
 162 {\s6\f0\fs24\ql\li720 The second argument.\par}
 163 {\s5\f1\fs20\ql\sb50\sa50 void\par}
 164 {\s6\f0\fs24\ql\li720 \par}
 165 \trowd\trgaph120\cellx1440\cellx5220\cellx9000
 166 \intbl\plain
 167 Called by:\cell function1()\cell README.c\cell\row
 168 Refs Func:\cell function1()\cell README.c\cell\row
 169 \intbl0
 170 }