cruft/doc/tmpl/comm_datadesc.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 Data description
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 Describing data to be exchanged
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9
  10 </para>
  11
  12 <!-- ##### SECTION See_Also ##### -->
  13 <para>
  14
  15 </para>
  16
  17 <!-- ##### USER_FUNCTION gras_datadesc_type_cb_int_t ##### -->
  18 <para>
  19
  20 </para>
  21
  22 @vars:
  23 @data:
  24 @Returns:
  25 <!-- # Unused Parameters # -->
  26 @p_type:
  27
  28
  29 <!-- ##### USER_FUNCTION gras_datadesc_type_cb_void_t ##### -->
  30 <para>
  31
  32 </para>
  33
  34 @vars:
  35 @data:
  36 <!-- # Unused Parameters # -->
  37 @p_type:
  38
  39
  40 <!-- ##### FUNCTION gras_datadesc_by_name ##### -->
  41 <para>
  42
  43 </para>
  44
  45 @name:
  46 @Returns:
  47 <!-- # Unused Parameters # -->
  48 @type:
  49
  50
  51 <!-- ##### MACRO GRAS_DEFINE_TYPE ##### -->
  52 <para>
  53
  54 </para>
  55
  56 @name:
  57 @def:
  58
  59
  60 <!-- ##### MACRO gras_datadesc_by_symbol ##### -->
  61 <para>
  62
  63 </para>
  64
  65 @name:
  66
  67
  68 <!-- ##### FUNCTION gras_datadesc_array_fixed ##### -->
  69 <para>
  70
  71 </para>
  72
  73 @name:
  74 @element_type:
  75 @fixed_size:
  76 @Returns:
  77 <!-- # Unused Parameters # -->
  78 @dst:
  79
  80
  81 <!-- ##### FUNCTION gras_datadesc_array_dyn ##### -->
  82 <para>
  83
  84 </para>
  85
  86 @name:
  87 @element_type:
  88 @dynamic_size:
  89 @Returns:
  90 <!-- # Unused Parameters # -->
  91 @dst:
  92
  93
  94 <!-- ##### FUNCTION gras_datadesc_ref ##### -->
  95 <para>
  96
  97 </para>
  98
  99 @name:
 100 @referenced_type:
 101 @Returns:
 102 <!-- # Unused Parameters # -->
 103 @dst:
 104
 105
 106 <!-- ##### FUNCTION gras_datadesc_ref_generic ##### -->
 107 <para>
 108
 109 </para>
 110
 111 @name:
 112 @selector:
 113 @Returns:
 114 <!-- # Unused Parameters # -->
 115 @dst:
 116 @discriminant:
 117
 118
 119 <!-- ##### FUNCTION gras_datadesc_struct ##### -->
 120 <para>
 121
 122 </para>
 123
 124 @name:
 125 @Returns:
 126 <!-- # Unused Parameters # -->
 127 @dst:
 128
 129
 130 <!-- ##### FUNCTION gras_datadesc_struct_append ##### -->
 131 <para>
 132
 133 </para>
 134
 135 @struct_type:
 136 @name:
 137 @field_type:
 138 <!-- # Unused Parameters # -->
 139 @Returns:
 140
 141
 142 <!-- ##### FUNCTION gras_datadesc_struct_close ##### -->
 143 <para>
 144
 145 </para>
 146
 147 @struct_type:
 148
 149
 150 <!-- ##### FUNCTION gras_datadesc_union ##### -->
 151 <para>
 152
 153 </para>
 154
 155 @name:
 156 @selector:
 157 @Returns:
 158 <!-- # Unused Parameters # -->
 159 @dst:
 160
 161
 162 <!-- ##### FUNCTION gras_datadesc_union_append ##### -->
 163 <para>
 164
 165 </para>
 166
 167 @union_type:
 168 @name:
 169 @field_type:
 170 <!-- # Unused Parameters # -->
 171 @Returns:
 172
 173
 174 <!-- ##### FUNCTION gras_datadesc_union_close ##### -->
 175 <para>
 176
 177 </para>
 178
 179 @union_type:
 180
 181
 182 <!-- ##### FUNCTION gras_datadesc_ref_pop_arr ##### -->
 183 <para>
 184
 185 </para>
 186
 187 @element_type:
 188 @Returns:
 189 <!-- # Unused Parameters # -->
 190 @dst:
 191
 192
 193 <!-- ##### FUNCTION gras_datadesc_cb_send ##### -->
 194 <para>
 195
 196 </para>
 197
 198 @type:
 199 @pre:
 200
 201
 202 <!-- ##### FUNCTION gras_datadesc_cb_recv ##### -->
 203 <para>
 204
 205 </para>
 206
 207 @type:
 208 @post:
 209
 210
 211 <!-- ##### FUNCTION gras_cbps_i_pop ##### -->
 212 <para>
 213
 214 </para>
 215
 216 @ps:
 217 @Returns:
 218
 219
 220 <!-- ##### FUNCTION gras_cbps_i_push ##### -->
 221 <para>
 222
 223 </para>
 224
 225 @ps:
 226 @val:
 227
 228
 229 <!-- ##### FUNCTION gras_cbps_v_pop ##### -->
 230 <para>
 231
 232 </para>
 233
 234 @ps:
 235 @name:
 236 @ddt:
 237 @res:
 238 @Returns:
 239
 240
 241 <!-- ##### FUNCTION gras_cbps_v_push ##### -->
 242 <para>
 243
 244 </para>
 245
 246 @ps:
 247 @name:
 248 @data:
 249 @ddt:
 250 @Returns:
 251
 252
 253 <!-- ##### FUNCTION gras_cbps_v_set ##### -->
 254 <para>
 255
 256 </para>
 257
 258 @ps:
 259 @name:
 260 @data:
 261 @ddt:
 262
 263
 264 <!-- ##### FUNCTION gras_cbps_v_get ##### -->
 265 <para>
 266
 267 </para>
 268
 269 @ps:
 270 @name:
 271 @ddt:
 272
 273
 274 <!-- ##### FUNCTION gras_cbps_block_begin ##### -->
 275 <para>
 276
 277 </para>
 278
 279 @ps:
 280
 281
 282 <!-- ##### FUNCTION gras_cbps_block_end ##### -->
 283 <para>
 284
 285 </para>
 286
 287 @ps:
 288
 289
 290 <!-- ##### FUNCTION gras_arch_selfid ##### -->
 291 <para>
 292
 293 </para>
 294
 295 @Returns:
 296
 297