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 @p_type:
  24 @data:
  25 @Returns:
  26
  27
  28 <!-- ##### USER_FUNCTION gras_datadesc_type_cb_void_t ##### -->
  29 <para>
  30
  31 </para>
  32
  33 @vars:
  34 @p_type:
  35 @data:
  36
  37
  38 <!-- ##### FUNCTION gras_datadesc_by_name ##### -->
  39 <para>
  40
  41 </para>
  42
  43 @name:
  44 @Returns:
  45 <!-- # Unused Parameters # -->
  46 @type:
  47
  48
  49 <!-- ##### MACRO GRAS_DEFINE_TYPE ##### -->
  50 <para>
  51
  52 </para>
  53
  54 @name:
  55 @def:
  56
  57
  58 <!-- ##### MACRO gras_datadesc_by_symbol ##### -->
  59 <para>
  60
  61 </para>
  62
  63 @name:
  64
  65
  66 <!-- ##### FUNCTION gras_datadesc_declare_array_fixed ##### -->
  67 <para>
  68
  69 </para>
  70
  71 @name:
  72 @element_type:
  73 @fixed_size:
  74 @dst:
  75 @Returns:
  76
  77
  78 <!-- ##### FUNCTION gras_datadesc_declare_array_dyn ##### -->
  79 <para>
  80
  81 </para>
  82
  83 @name:
  84 @element_type:
  85 @dynamic_size:
  86 @dst:
  87 @Returns:
  88 <!-- # Unused Parameters # -->
  89 @elm_type:
  90 @code:
  91
  92
  93 <!-- ##### FUNCTION gras_datadesc_declare_ref ##### -->
  94 <para>
  95
  96 </para>
  97
  98 @name:
  99 @referenced_type:
 100 @dst:
 101 @Returns:
 102 <!-- # Unused Parameters # -->
 103 @ref_type:
 104 @code:
 105
 106
 107 <!-- ##### FUNCTION gras_datadesc_declare_ref_generic ##### -->
 108 <para>
 109
 110 </para>
 111
 112 @name:
 113 @discriminant:
 114 @dst:
 115 @Returns:
 116
 117
 118 <!-- ##### FUNCTION gras_datadesc_declare_struct ##### -->
 119 <para>
 120
 121 </para>
 122
 123 @name:
 124 @dst:
 125 @Returns:
 126 <!-- # Unused Parameters # -->
 127 @code:
 128
 129
 130 <!-- ##### FUNCTION gras_datadesc_declare_struct_append ##### -->
 131 <para>
 132
 133 </para>
 134
 135 @struct_type:
 136 @name:
 137 @field_type:
 138 @Returns:
 139
 140
 141 <!-- ##### FUNCTION gras_datadesc_declare_struct_close ##### -->
 142 <para>
 143
 144 </para>
 145
 146 @struct_type:
 147
 148
 149 <!-- ##### FUNCTION gras_datadesc_declare_union ##### -->
 150 <para>
 151
 152 </para>
 153
 154 @name:
 155 @selector:
 156 @dst:
 157 @Returns:
 158 <!-- # Unused Parameters # -->
 159 @code:
 160
 161
 162 <!-- ##### FUNCTION gras_datadesc_declare_union_append ##### -->
 163 <para>
 164
 165 </para>
 166
 167 @union_type:
 168 @name:
 169 @field_type:
 170 @Returns:
 171
 172
 173 <!-- ##### FUNCTION gras_datadesc_declare_union_close ##### -->
 174 <para>
 175
 176 </para>
 177
 178 @union_type:
 179
 180
 181 <!-- ##### FUNCTION gras_datadesc_cb_set_pre ##### -->
 182 <para>
 183
 184 </para>
 185
 186 @type:
 187 @pre:
 188
 189
 190 <!-- ##### FUNCTION gras_datadesc_cb_set_post ##### -->
 191 <para>
 192
 193 </para>
 194
 195 @type:
 196 @post:
 197
 198
 199 <!-- ##### FUNCTION gras_dd_cbps_pop ##### -->
 200 <para>
 201
 202 </para>
 203
 204 @ps:
 205 @name:
 206 @ddt:
 207
 208
 209 <!-- ##### FUNCTION gras_dd_cbps_push ##### -->
 210 <para>
 211
 212 </para>
 213
 214 @ps:
 215 @name:
 216 @data:
 217 @ddt:
 218
 219
 220 <!-- ##### FUNCTION gras_dd_cbps_set ##### -->
 221 <para>
 222
 223 </para>
 224
 225 @ps:
 226 @name:
 227 @data:
 228 @ddt:
 229
 230
 231 <!-- ##### FUNCTION gras_dd_cbps_get ##### -->
 232 <para>
 233
 234 </para>
 235
 236 @ps:
 237 @name:
 238 @ddt:
 239
 240
 241 <!-- ##### FUNCTION gras_dd_cbps_block_begin ##### -->
 242 <para>
 243
 244 </para>
 245
 246 @ps:
 247
 248
 249 <!-- ##### FUNCTION gras_dd_cbps_block_end ##### -->
 250 <para>
 251
 252 </para>
 253
 254 @ps:
 255
 256
 257 <!-- ##### FUNCTION gras_arch_selfid ##### -->
 258 <para>
 259
 260 </para>
 261
 262 @Returns:
 263
 264