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

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