_src/Test/tools/T_TextSection/Files/T_ConvertDCF/NaturalDocs.c

   1 /***********************************************************************\r
   2 * File: Docs.c\r
   3 *    1st document.\r
   4 *\r
   5 * - $version: 1.00 $\r
   6 * - $Author: Tom $\r
   7 * - Description: This is a description.\r
   8 ************************************************************************/\r
   9 \r
  10 /***********************************************************************\r
  11 * Function: SampleFunction\r
  12 *    This is a brief.\r
  13 *\r
  14 * Arguments:\r
  15 *    Source      - Input\r
  16 *    Destination - Output\r
  17 *\r
  18 * Return Value:\r
  19 *    Error Code. 0=No Error.\r
  20 *\r
  21 * Description:\r
  22 *    The output from <SampleFunction>.\r
  23 *\r
  24 * Example:\r
  25 *    > void  main()\r
  26 *    >     {}\r
  27 ************************************************************************/\r
  28 errnum_t  SampleFunction( int Source, int Destination )\r
  29 {\r
  30         return  Source + Destination;\r
  31 }\r
  32 \r
  33 \r
  34 /***********************************************************************\r
  35 * Structure: SampleClass\r
  36 *    SampleClassBrief.\r
  37 ************************************************************************/\r
  38 typedef struct _SampleClass  SampleClass;\r
  39 struct _SampleClass {\r
  40 \r
  41     /* Variable: duration_msec\r
  42         See "TimerClass". */\r
  43     uint16_t  duration_msec;\r
  44 \r
  45     /* Variable: reserved */\r
  46     uint16_t  reserved;\r
  47 \r
  48     /*-------------------------------------------------------*/\r
  49     /* Group: Colors */\r
  50 \r
  51     /* Variable: color */\r
  52     uint32_t  color;\r
  53 };\r
  54 \r
  55 \r
  56 /***********************************************************************\r
  57 * Structure: Sample2_Class\r
  58 ************************************************************************/\r
  59 typedef struct _Sample2_Class  Sample2_Class;\r
  60 struct _Sample2_Class {\r
  61     uint32_t  color;\r
  62 };\r
  63 \r
  64 \r
  65 /***********************************************************************\r
  66 * Function: SampleFunction1\r
  67 *    This is a brief.\r
  68 *\r
  69 * Arguments:\r
  70 *    Source      - Input\r
  71 *    Destination - Output\r
  72 *\r
  73 * Return Value:\r
  74 *    Error Code. 0=No Error.\r
  75 *\r
  76 * Example:\r
  77 *    >SampleFunction( 0, 0 );\r
  78 ************************************************************************/\r
  79 errnum_t  SampleFunction( int Source, int Destination )\r
  80 {\r
  81         return  Source + Destination;\r
  82 }\r
  83 \r
  84 \r
  85 /***********************************************************************\r
  86 * Function: SampleFunction2\r
  87 *    This is a brief 2.\r
  88 *\r
  89 * Arguments:\r
  90 *    None\r
  91 *\r
  92 * Return Value:\r
  93 *    None\r
  94 *\r
  95 * Example:\r
  96 *    > void  main()\r
  97 *    >     {}\r
  98 *\r
  99 * Description:\r
 100 *    The output from <SampleFunction>.\r
 101 ************************************************************************/\r
 102 errnum_t  SampleFunction2( int Source, int Destination )\r
 103 {\r
 104         return  Source + Destination;\r
 105 }\r
 106 \r
 107 \r
 108 /***********************************************************************\r
 109 * Function: SampleFunction3\r
 110 *    This is a brief 3.\r
 111 *\r
 112 * Arguments:\r
 113 *    None\r
 114 *\r
 115 * Return Value:\r
 116 *    None\r
 117 ************************************************************************/\r
 118 errnum_t  SampleFunction3( int Source, int Destination )\r
 119 {\r
 120         return  Source + Destination;\r
 121 }\r
 122 \r
 123 \r
 124 /***********************************************************************\r
 125 * Function: SampleFunction0\r
 126 ************************************************************************/\r
 127 errnum_t  SampleFunction0( int Source, int Destination )\r
 128 {\r
 129         return  Source + Destination;\r
 130 }\r
 131 \r
 132 \r
 133 /***********************************************************************\r
 134 * Enumeration: SampleEnum\r
 135 *    Sample Enum\r
 136 *\r
 137 *    : SymbolA - 0, NULL\r
 138 *    : SymbolB - 1\r
 139 *\r
 140 *    - Normal List 1\r
 141 *    - Normal List 2\r
 142 ************************************************************************/\r
 143 typedef enum _SampleEnum  SampleEnum;\r
 144 enum _SampleEnum {\r
 145         SymbolA,\r
 146         SymbolB,\r
 147 };\r
 148 \r
 149 \r
 150 /***********************************************************************\r
 151 * Type: ARGB8888Type\r
 152 *    Color fomat\r
 153 ************************************************************************/\r
 154 typedef uint32_t  ARGB8888Type;\r
 155 \r
 156 \r
 157 /***********************************************************************\r
 158 * Macro: N_MACRO\r
 159 *    No parameter macro\r
 160 *\r
 161 * Arguments:\r
 162 *    None.\r
 163 *\r
 164 * Return Value:\r
 165 *    None.\r
 166 ************************************************************************/\r
 167 #define  N_MACRO()  (1)\r
 168 \r
 169 \r
 170 /***********************************************************************\r
 171 * Macro: A_MACRO\r
 172 *    With parameter macro\r
 173 *\r
 174 * Arguments:\r
 175 *    x - Input\r
 176 *\r
 177 * Return Value:\r
 178 *    Error Code. 0=No Err.\r
 179 ************************************************************************/\r
 180 #define  A_MACRO( x )  ((x)+1)\r
 181 \r
 182 \r
 183 /***********************************************************************\r
 184 * Constant: VALUE_CONSTANT\r
 185 *    No parameter macro\r
 186 ************************************************************************/\r
 187 #define  VALUE_CONSTANT  1\r
 188 \r
 189 \r
 190 /***********************************************************************\r
 191 * Constants: BYTE_ENDIAN\r
 192 *\r
 193 *    BYTE_LITTLE_ENDIAN - Little endian\r
 194 *    BYTE_BIG_ENDIAN    - Big endian\r
 195 ************************************************************************/\r
 196 #define  BYTE_LITTLE_ENDIAN  1\r
 197 #define  BYTE_BIG_ENDIAN     2\r
 198 \r
 199 \r