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