kernel/doc/doxygroups.h

   1
   2 /* Definitions of modules and its relations for generating Doxygen documentation */
   3
   4 /** @defgroup genericadt Data types
   5  * @ingroup kernel
   6  */
   7
   8 /** @defgroup main Kernel initialization
   9  * @ingroup others
  10  */
  11
  12 /** @defgroup genericconsole Kernel console
  13  * @ingroup others
  14  */
  15
  16 /**
  17   * @defgroup time Time management
  18   * @ingroup kernel
  19   */
  20
  21 /**
  22   * @defgroup proc Scheduling
  23   * @ingroup kernel
  24   */
  25
  26         /** @defgroup genericproc generic
  27         * @ingroup proc
  28         */
  29
  30         /**
  31          * @cond amd64
  32          * @defgroup amd64proc amd64
  33          * @ingroup proc
  34          * @endcond
  35          */
  36
  37         /**
  38          * @cond ia32
  39          * @defgroup ia32proc ia32
  40          * @ingroup proc
  41          * @endcond
  42          */
  43
  44         /**
  45          * @cond ia64
  46          * @defgroup ia64proc ia64
  47          * @ingroup proc
  48          * @endcond
  49          */
  50
  51         /**
  52          * @cond mips32
  53          * @defgroup mips32proc mips32
  54          * @ingroup proc
  55          * @endcond
  56          */
  57
  58         /**
  59          * @cond ppc32
  60          * @defgroup ppc32proc ppc32
  61          * @ingroup proc
  62          * @endcond
  63          */
  64
  65         /**
  66          * @cond ppc64
  67          * @defgroup ppc64proc ppc64
  68          * @ingroup proc
  69          * @endcond
  70          */
  71
  72         /**
  73          * @cond sparc64
  74          * @defgroup sparc64proc sparc64
  75          * @ingroup proc
  76          * @endcond
  77          */
  78
  79
  80 /** @defgroup sync Synchronization
  81  * @ingroup kernel
  82  */
  83
  84
  85  /** @defgroup mm Memory management
  86   * @ingroup kernel
  87   */
  88
  89         /**
  90          * @defgroup genericmm generic
  91          * @ingroup mm
  92          */
  93
  94         /**
  95          * @defgroup genarchmm genarch
  96          * @ingroup mm
  97          */
  98
  99         /**
 100          * @cond amd64
 101          * @defgroup amd64mm amd64
 102          * @ingroup mm
 103          * @endcond
 104          */
 105
 106         /**
 107          * @cond ia32
 108          * @defgroup ia32mm ia32
 109          * @ingroup mm
 110          * @endcond
 111          */
 112
 113         /**
 114          * @cond ia64
 115          * @defgroup ia64mm ia64
 116          * @ingroup mm
 117          * @endcond
 118          */
 119
 120         /**
 121          * @cond mips32
 122          * @defgroup mips32mm mips32
 123          * @ingroup mm
 124          * @endcond
 125          */
 126
 127         /**
 128          * @cond ppc32
 129          * @defgroup ppc32mm ppc32
 130          * @ingroup mm
 131          * @endcond
 132          */
 133
 134         /**
 135          * @cond ppc64
 136          * @defgroup ppc64mm ppc64
 137          * @ingroup mm
 138          * @endcond
 139          */
 140
 141         /**
 142          * @cond sparc64
 143          * @defgroup sparc64mm sparc64
 144          * @ingroup mm
 145          * @endcond
 146          */
 147
 148
 149
 150 /** @defgroup genericipc IPC
 151  * @ingroup kernel
 152  */
 153
 154 /** @defgroup genericklog KLog
 155  * @brief Kernel logging facility
 156  * @ingroup genericconsole
 157  */
 158
 159
 160 /** @defgroup ddi Device Driver Interface
 161  * @ingroup kernel
 162  */
 163
 164         /** @defgroup genericddi generic
 165         * @ingroup ddi
 166         */
 167
 168         /**
 169          * @cond amd64
 170          * @defgroup amd64ddi amd64
 171          * @ingroup ddi
 172          * @endcond
 173          */
 174
 175         /**
 176          * @cond ia32
 177          * @defgroup ia32ddi ia32
 178          * @ingroup ddi
 179          * @endcond
 180          */
 181
 182         /**
 183          * @cond ia64
 184          * @defgroup ia64ddi ia64
 185          * @ingroup ddi
 186          * @endcond
 187          */
 188
 189         /**
 190          * @cond mips32
 191          * @defgroup mips32ddi mips32
 192          * @ingroup ddi
 193          * @endcond
 194          */
 195
 196         /**
 197          * @cond ppc32
 198          * @defgroup ppc32ddi ppc32
 199          * @ingroup ddi
 200          * @endcond
 201          */
 202
 203         /**
 204          * @cond ppc64
 205          * @defgroup ppc64ddi ppc64
 206          * @ingroup ddi
 207          * @endcond
 208          */
 209
 210         /**
 211          * @cond sparc64
 212          * @defgroup sparc64ddi sparc64
 213          * @ingroup ddi
 214          * @endcond
 215          */
 216
 217  /** @defgroup debug Debugging
 218  * @ingroup others
 219  */
 220
 221         /** @defgroup genericdebug generic
 222         * @ingroup debug
 223         */
 224
 225         /**
 226          * @cond amd64
 227          * @defgroup amd64debug ia32/amd64
 228          * @ingroup debug
 229          * @endcond
 230          */
 231
 232         /**
 233          * @cond ia32
 234          * @defgroup amd64debug ia32/amd64
 235          * @ingroup debug
 236          * @endcond
 237          */
 238
 239         /**
 240          * @cond ia64
 241          * @defgroup ia64debug ia64
 242          * @ingroup debug
 243          * @endcond
 244          */
 245
 246         /**
 247          * @cond mips32
 248          * @defgroup mips32debug mips32
 249          * @ingroup debug
 250          * @endcond
 251          */
 252
 253         /**
 254          * @cond ppc32
 255          * @defgroup ppc32debug ppc32
 256          * @ingroup debug
 257          * @endcond
 258          */
 259
 260         /**
 261          * @cond ppc64
 262          * @defgroup ppc64debug ppc64
 263          * @ingroup debug
 264          * @endcond
 265          */
 266
 267         /**
 268          * @cond sparc64
 269          * @defgroup sparc64debug sparc64
 270          * @ingroup debug
 271          * @endcond
 272          */
 273
 274  /** @defgroup interrupt Interrupt handling and dispatching
 275   * @ingroup kernel
 276   */
 277         /**
 278          * @defgroup genericinterrupt generic
 279          * @ingroup interrupt
 280          */
 281
 282         /**
 283          * @cond amd64
 284          * @defgroup amd64interrupt amd64
 285          * @ingroup interrupt
 286          * @endcond
 287          */
 288
 289         /**
 290          * @cond ia32
 291          * @defgroup ia32interrupt ia32
 292          * @ingroup interrupt
 293          * @endcond
 294          */
 295
 296         /**
 297          * @cond ia64
 298          * @defgroup ia64interrupt ia64
 299          * @ingroup interrupt
 300          * @endcond
 301          */
 302
 303         /**
 304          * @cond mips32
 305          * @defgroup mips32interrupt mips32
 306          * @ingroup interrupt
 307          * @endcond
 308          */
 309
 310         /**
 311          * @cond ppc32
 312          * @defgroup ppc32interrupt ppc32
 313          * @ingroup interrupt
 314          * @endcond
 315          */
 316
 317         /**
 318          * @cond ppc64
 319          * @defgroup ppc64interrupt ppc64
 320          * @ingroup interrupt
 321          * @endcond
 322          */
 323
 324         /**
 325          * @cond sparc64
 326          * @defgroup sparc64interrupt sparc64
 327          * @ingroup interrupt
 328          * @endcond
 329          */
 330
 331
 332 /** @defgroup others Miscellanea
 333  * @ingroup kernel
 334  */
 335         /** @defgroup generic generic
 336         * @ingroup others
 337         */
 338
 339         /** @defgroup genarch genarch
 340         * @ingroup others
 341         */
 342
 343         /**
 344          * @cond amd64
 345          * @defgroup amd64 amd64
 346          * @ingroup others
 347          * @endcond
 348          */
 349
 350         /**
 351          * @cond ia32
 352          * @defgroup ia32 ia32
 353          * @ingroup others
 354          * @endcond
 355          */
 356
 357         /**
 358          * @cond ia64
 359          * @defgroup ia64 ia64
 360          * @ingroup others
 361          * @endcond
 362          */
 363
 364         /**
 365          * @cond mips32
 366          * @defgroup mips32 mips32
 367          * @ingroup others
 368          * @endcond
 369          */
 370
 371         /**
 372          * @cond ppc32
 373          * @defgroup ppc32 ppc32
 374          * @ingroup others
 375          * @endcond
 376          */
 377
 378         /**
 379          * @cond ppc64
 380          * @defgroup ppc64 ppc64
 381          * @ingroup others
 382          * @endcond
 383          */
 384
 385         /**
 386          * @cond sparc64
 387          * @defgroup sparc64 sparc64
 388          * @ingroup others
 389          * @endcond
 390          */