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 <!-- ##### FUNCTION gras_datadesc_by_name ##### -->
  18 <para>
  19
  20 </para>
  21
  22 @name:
  23 @type:
  24 @Returns:
  25
  26
  27 <!-- ##### MACRO gras_datadesc_by_symbol ##### -->
  28 <para>
  29
  30 </para>
  31
  32 @name:
  33
  34
  35 <!-- ##### FUNCTION gras_datadesc_import_nws ##### -->
  36 <para>
  37
  38 </para>
  39
  40 @name:
  41 @desc:
  42 @howmany:
  43 @dst:
  44 @Returns:
  45
  46
  47 <!-- ##### FUNCTION gras_datadesc_declare_array_dyn ##### -->
  48 <para>
  49
  50 </para>
  51
  52 @name:
  53 @element_type:
  54 @dynamic_size:
  55 @dst:
  56 @Returns:
  57 <!-- # Unused Parameters # -->
  58 @elm_type:
  59 @code:
  60
  61
  62 <!-- ##### FUNCTION gras_datadesc_declare_ref ##### -->
  63 <para>
  64
  65 </para>
  66
  67 @name:
  68 @referenced_type:
  69 @dst:
  70 @Returns:
  71 <!-- # Unused Parameters # -->
  72 @ref_type:
  73 @code:
  74
  75
  76 <!-- ##### FUNCTION gras_datadesc_declare_struct ##### -->
  77 <para>
  78
  79 </para>
  80
  81 @name:
  82 @dst:
  83 @Returns:
  84 <!-- # Unused Parameters # -->
  85 @code:
  86
  87
  88 <!-- ##### FUNCTION gras_datadesc_declare_struct_append_name ##### -->
  89 <para>
  90
  91 </para>
  92
  93 @struct_type:
  94 @name:
  95 @field_type_name:
  96 @Returns:
  97
  98
  99 <!-- ##### FUNCTION gras_datadesc_declare_union ##### -->
 100 <para>
 101
 102 </para>
 103
 104 @name:
 105 @selector:
 106 @dst:
 107 @Returns:
 108 <!-- # Unused Parameters # -->
 109 @code:
 110
 111
 112 <!-- ##### FUNCTION gras_datadesc_declare_union_append_name ##### -->
 113 <para>
 114
 115 </para>
 116
 117 @union_type:
 118 @name:
 119 @field_type_name:
 120 @Returns:
 121
 122
 123 <!-- ##### FUNCTION gras_datadesc_cb_set_pre ##### -->
 124 <para>
 125
 126 </para>
 127
 128 @type:
 129 @pre:
 130
 131
 132 <!-- ##### FUNCTION gras_datadesc_cb_set_post ##### -->
 133 <para>
 134
 135 </para>
 136
 137 @type:
 138 @post:
 139
 140
 141 <!-- ##### FUNCTION gras_dd_cbps_pop ##### -->
 142 <para>
 143
 144 </para>
 145
 146 @ps:
 147 @name:
 148 @ddt:
 149
 150
 151 <!-- ##### FUNCTION gras_dd_cbps_push ##### -->
 152 <para>
 153
 154 </para>
 155
 156 @ps:
 157 @name:
 158 @data:
 159 @ddt:
 160
 161
 162 <!-- ##### FUNCTION gras_dd_cbps_set ##### -->
 163 <para>
 164
 165 </para>
 166
 167 @ps:
 168 @name:
 169 @data:
 170 @ddt:
 171
 172
 173 <!-- ##### FUNCTION gras_dd_cbps_get ##### -->
 174 <para>
 175
 176 </para>
 177
 178 @ps:
 179 @name:
 180 @ddt:
 181
 182
 183 <!-- ##### FUNCTION gras_dd_cbps_block_begin ##### -->
 184 <para>
 185
 186 </para>
 187
 188 @ps:
 189
 190
 191 <!-- ##### FUNCTION gras_dd_cbps_block_end ##### -->
 192 <para>
 193
 194 </para>
 195
 196 @ps:
 197
 198
 199 <!-- ##### FUNCTION gras_arch_selfid ##### -->
 200 <para>
 201
 202 </para>
 203
 204 @Returns:
 205
 206