1 ///
   2 // Title
   3 // -----
   4 
   5 ///
   6 // short description
   7 int a(int param, int arg);
   8 
   9 ///
  10 // short description
  11 // longer description
  12 int b(int param, int arg);
  13 
  14 ///
  15 // short description
  16 //
  17 // longer description with empty line
  18 int c(int param, int arg);
  19 
  20 ///
  21 // short description
  22 // longer description
  23 // which needs two lines
  24 int d(int param, int arg);
  25 
  26 ///
  27 // short description
  28 //
  29 // longer description with empty line
  30 // which needs two lines
  31 int e(int param, int arg);
  32 
  33 ///
  34 // condensed format
  35 // @param: desc param
  36 // @arg: desc arg
  37 // @return: desc return
  38 // longer description
  39 int f(int param, int arg);
  40 
  41 ///
  42 // more airy format
  43 //
  44 // @param: desc param
  45 // @arg: desc arg
  46 // @return: desc return
  47 //
  48 // longer description
  49 int g(int param, int arg);
  50 
  51 ///
  52 // short description
  53 // @return: ``1`` if @param is zero,
  54 //      ``0`` otherwise.
  55 int h(int param, int arg);
  56 
  57 ///
  58 // short description
  59 // @return:
  60 //      * ``1`` if @param is zero,
  61 //      * ``0`` otherwise.
  62 int i(int param, int arg);
  63 
  64 ///
  65 // short description
  66 int m(int param, int arg)
  67 { return 0; }
  68 
  69 ///
  70 // short description
  71 int n(int param,
  72         int arg)
  73 { return 0; }
  74 
  75 ///
  76 // short description
  77 int o(int param, int arg);
  78 
  79 ///
  80 // short description
  81 int p(int param,
  82         int arg);
  83 
  84 
  85 /*
  86  * check-name: cdoc
  87  * check-command: Documentation/sphinx/cdoc.py < $file
  88  *
  89  * check-output-start
  90    2: Title
  91    3: -----
  92    4: 
  93    4: 
  94    5: 
  95    7: .. c:function:: int a(int param, int arg)
  96    8: 
  97    6:   Short description.
  98    7: 
  99   12: .. c:function:: int b(int param, int arg)
 100   13: 
 101   10:   Short description.
 102   11: 
 103   11:   longer description
 104   12: 
 105   18: .. c:function:: int c(int param, int arg)
 106   19: 
 107   15:   Short description.
 108   16: 
 109   17:   longer description with empty line
 110   18: 
 111   24: .. c:function:: int d(int param, int arg)
 112   25: 
 113   21:   Short description.
 114   22: 
 115   22:   longer description
 116   23:   which needs two lines
 117   24: 
 118   31: .. c:function:: int e(int param, int arg)
 119   32: 
 120   27:   Short description.
 121   28: 
 122   29:   longer description with empty line
 123   30:   which needs two lines
 124   31: 
 125   39: .. c:function:: int f(int param, int arg)
 126   40: 
 127   34:   Condensed format.
 128   35: 
 129   35:   :param param: desc param
 130   36:   :param arg: desc arg
 131   37:   :return: desc return
 132   38: 
 133   38:   longer description
 134   39: 
 135   49: .. c:function:: int g(int param, int arg)
 136   50: 
 137   42:   More airy format.
 138   43: 
 139   44:   :param param: desc param
 140   45:   :param arg: desc arg
 141   46:   :return: desc return
 142   47: 
 143   48:   longer description
 144   49: 
 145   55: .. c:function:: int h(int param, int arg)
 146   56: 
 147   52:   Short description.
 148   53: 
 149   53:   :return: ``1`` if **param** is zero,
 150   54:           ``0`` otherwise.
 151   54: 
 152   62: .. c:function:: int i(int param, int arg)
 153   63: 
 154   58:   Short description.
 155   59: 
 156   59:   :return: 
 157   60:           * ``1`` if **param** is zero,
 158   61:           * ``0`` otherwise.
 159   60: 
 160   66: .. c:function:: int m(int param, int arg)
 161   67: 
 162   65:   Short description.
 163   66: 
 164   71: .. c:function:: int n(int param, int arg)
 165   72: 
 166   70:   Short description.
 167   71: 
 168   77: .. c:function:: int o(int param, int arg)
 169   78: 
 170   76:   Short description.
 171   77: 
 172   81: .. c:function:: int p(int param, int arg)
 173   82: 
 174   80:   Short description.
 175   81: 
 176  * check-output-end
 177  */