kernel/doc/doxygroups.h

   1 /* Definitions of modules and its relations for generating Doxygen documentation */
   2
   3 /** @defgroup kernel kernel
   4  * @brief HelenOS kernel
   5  */
   6
   7 /** @defgroup kernel_generic_adt Data types
   8  * @ingroup kernel
   9  */
  10
  11 /** @defgroup kernel_generic_console Kernel console
  12  * @ingroup others
  13  */
  14
  15 /** @defgroup kernel_time Time management
  16  * @ingroup kernel
  17  */
  18
  19 /** @defgroup proc Scheduling
  20  * @ingroup kernel
  21  */
  22
  23 /**    @defgroup kernel_generic_proc generic
  24  *     @ingroup proc
  25  */
  26
  27 /**
  28  *     @cond abs32le
  29  *     @defgroup kernel_abs32le_proc abs32le
  30  *     @ingroup proc
  31  *     @endcond
  32  */
  33
  34 /**
  35  *     @cond amd64
  36  *     @defgroup kernel_amd64_proc amd64
  37  *     @ingroup proc
  38  *     @endcond
  39  */
  40
  41 /**
  42  *     @cond arm32
  43  *     @defgroup kernel_arm32_proc arm32
  44  *     @ingroup proc
  45  *     @endcond
  46  */
  47
  48 /**
  49  *     @cond ia32
  50  *     @defgroup kernel_ia32_proc ia32
  51  *     @ingroup proc
  52  *     @endcond
  53  */
  54
  55 /**
  56  *     @cond ia64
  57  *     @defgroup kernel_ia64_proc ia64
  58  *     @ingroup proc
  59  *     @endcond
  60  */
  61
  62 /**
  63  *     @cond mips32
  64  *     @defgroup kernel_mips32_proc mips32
  65  *     @ingroup proc
  66  *     @endcond
  67  */
  68
  69 /**
  70  *     @cond ppc32
  71  *     @defgroup kernel_ppc32_proc ppc32
  72  *     @ingroup proc
  73  *     @endcond
  74  */
  75
  76 /**
  77  *     @cond riscv64
  78  *     @defgroup kernel_riscv64_proc riscv64
  79  *     @ingroup proc
  80  *     @endcond
  81  */
  82
  83 /**
  84  *     @cond sparc64
  85  *     @defgroup kernel_sparc64_proc sparc64
  86  *     @ingroup proc
  87  *     @endcond
  88  */
  89
  90 /** @defgroup kernel_sync Synchronization
  91  * @ingroup kernel
  92  */
  93
  94 /** @defgroup mm Memory management
  95  * @ingroup kernel
  96  */
  97
  98 /**
  99  *     @defgroup kernel_generic_mm generic
 100  *     @ingroup mm
 101  */
 102
 103 /**
 104  *     @defgroup kernel_genarch_mm genarch
 105  *     @ingroup mm
 106  */
 107
 108 /**
 109  *     @cond abs32le
 110  *     @defgroup kernel_abs32le_mm abs32le
 111  *     @ingroup mm
 112  *     @endcond
 113  */
 114
 115 /**
 116  *     @cond amd64
 117  *     @defgroup kernel_amd64_mm amd64
 118  *     @ingroup mm
 119  *     @endcond
 120  */
 121
 122 /**
 123  *     @cond arm32
 124  *     @defgroup kernel_arm32_mm arm32
 125  *     @ingroup mm
 126  *     @endcond
 127  */
 128
 129 /**
 130  *     @cond ia32
 131  *     @defgroup kernel_ia32_mm ia32
 132  *     @ingroup mm
 133  *     @endcond
 134  */
 135
 136 /**
 137  *     @cond ia64
 138  *     @defgroup kernel_ia64_mm ia64
 139  *     @ingroup mm
 140  *     @endcond
 141  */
 142
 143 /**
 144  *     @cond mips32
 145  *     @defgroup kernel_mips32_mm mips32
 146  *     @ingroup mm
 147  *     @endcond
 148  */
 149
 150 /**
 151  *     @cond ppc32
 152  *     @defgroup kernel_ppc32_mm ppc32
 153  *     @ingroup mm
 154  *     @endcond
 155  */
 156
 157 /**
 158  *     @cond riscv64
 159  *     @defgroup kernel_riscv64_mm riscv64
 160  *     @ingroup mm
 161  *     @endcond
 162  */
 163
 164 /**
 165  *     @cond sparc64
 166  *     @defgroup kernel_sparc64_mm sparc64
 167  *     @ingroup mm
 168  *     @endcond
 169  */
 170
 171 /** @defgroup kernel_generic_ipc IPC
 172  * @ingroup kernel
 173  */
 174
 175 /** @defgroup kernel_generic_kio KIO
 176  * @brief Kernel character input/output facility
 177  * @ingroup kernel_generic_console
 178  */
 179
 180 /** @defgroup ddi Device Driver Interface
 181  * @ingroup kernel
 182  */
 183
 184 /**
 185  *     @defgroup kernel_generic_ddi generic
 186  *     @ingroup ddi
 187  */
 188
 189 /**
 190  *     @cond abs32le
 191  *     @defgroup kernel_abs32le_ddi abs32le
 192  *     @ingroup ddi
 193  *     @endcond
 194  */
 195
 196 /**
 197  *     @cond amd64
 198  *     @defgroup kernel_amd64_ddi amd64
 199  *     @ingroup ddi
 200  *     @endcond
 201  */
 202
 203 /**
 204  *     @cond arm32
 205  *     @defgroup kernel_arm32_ddi arm32
 206  *     @ingroup ddi
 207  *     @endcond
 208  */
 209
 210 /**
 211  *     @cond ia32
 212  *     @defgroup kernel_ia32_ddi ia32
 213  *     @ingroup ddi
 214  *     @endcond
 215  */
 216
 217 /**
 218  *     @cond ia64
 219  *     @defgroup kernel_ia64_ddi ia64
 220  *     @ingroup ddi
 221  *     @endcond
 222  */
 223
 224 /**
 225  *     @cond mips32
 226  *     @defgroup kernel_mips32_ddi mips32
 227  *     @ingroup ddi
 228  *     @endcond
 229  */
 230
 231 /**
 232  *     @cond ppc32
 233  *     @defgroup kernel_ppc32_ddi ppc32
 234  *     @ingroup ddi
 235  *     @endcond
 236  */
 237
 238 /**
 239  *     @cond riscv64
 240  *     @defgroup kernel_riscv64_ddi riscv64
 241  *     @ingroup ddi
 242  *     @endcond
 243  */
 244
 245 /**
 246  *     @cond sparc64
 247  *     @defgroup kernel_sparc64_ddi sparc64
 248  *     @ingroup ddi
 249  *     @endcond
 250  */
 251
 252 /** @defgroup debug Debugging
 253  * @ingroup others
 254  */
 255
 256 /**
 257  *     @defgroup kernel_generic_debug generic
 258  *     @ingroup debug
 259  */
 260
 261 /**
 262  *     @cond abs32le
 263  *     @defgroup kernel_abs32le_debug abs32le
 264  *     @ingroup debug
 265  *     @endcond
 266  */
 267
 268 /**
 269  *     @cond amd64
 270  *     @defgroup kernel_amd64_debug ia32/amd64
 271  *     @ingroup debug
 272  *     @endcond
 273  */
 274
 275 /**
 276  *     @cond arm32
 277  *     @defgroup kernel_arm32_debug arm32
 278  *     @ingroup debug
 279  *     @endcond
 280  */
 281
 282 /**
 283  *     @cond ia32
 284  *     @defgroup kernel_amd64_debug ia32/amd64
 285  *     @ingroup debug
 286  *     @endcond
 287  */
 288
 289 /**
 290  *     @cond ia64
 291  *     @defgroup kernel_ia64_debug ia64
 292  *     @ingroup debug
 293  *     @endcond
 294  */
 295
 296 /**
 297  *     @cond mips32
 298  *     @defgroup kernel_mips32_debug mips32
 299  *     @ingroup debug
 300  *     @endcond
 301  */
 302
 303 /**
 304  *     @cond ppc32
 305  *     @defgroup kernel_ppc32_debug ppc32
 306  *     @ingroup debug
 307  *     @endcond
 308  */
 309
 310 /**
 311  *     @cond riscv64
 312  *     @defgroup kernel_riscv64_debug riscv64
 313  *     @ingroup debug
 314  *     @endcond
 315  */
 316
 317 /**
 318  *     @cond sparc64
 319  *     @defgroup kernel_sparc64_debug sparc64
 320  *     @ingroup debug
 321  *     @endcond
 322  */
 323
 324 /** @defgroup interrupt Interrupt handling and dispatching
 325  * @ingroup kernel
 326  */
 327 /**
 328  *     @defgroup kernel_generic_interrupt generic
 329  *     @ingroup interrupt
 330  */
 331
 332 /**
 333  *     @cond abs32le
 334  *     @defgroup kernel_abs32le_interrupt abs32le
 335  *     @ingroup interrupt
 336  *     @endcond
 337  */
 338
 339 /**
 340  *     @cond amd64
 341  *     @defgroup kernel_amd64_interrupt amd64
 342  *     @ingroup interrupt
 343  *     @endcond
 344  */
 345
 346 /**
 347  *     @cond arm32
 348  *     @defgroup kernel_arm32_interrupt arm32
 349  *     @ingroup interrupt
 350  *     @endcond
 351  */
 352
 353 /**
 354  *     @cond ia32
 355  *     @defgroup kernel_ia32_interrupt ia32
 356  *     @ingroup interrupt
 357  *     @endcond
 358  */
 359
 360 /**
 361  *     @cond ia64
 362  *     @defgroup kernel_ia64_interrupt ia64
 363  *     @ingroup interrupt
 364  *     @endcond
 365  */
 366
 367 /**
 368  *     @cond mips32
 369  *     @defgroup kernel_mips32_interrupt mips32
 370  *     @ingroup interrupt
 371  *     @endcond
 372  */
 373
 374 /**
 375  *     @cond ppc32
 376  *     @defgroup kernel_ppc32_interrupt ppc32
 377  *     @ingroup interrupt
 378  *     @endcond
 379  */
 380
 381 /**
 382  *     @cond riscv64
 383  *     @defgroup kernel_riscv64_interrupt riscv64
 384  *     @ingroup interrupt
 385  *     @endcond
 386  */
 387
 388 /**
 389  *     @cond sparc64
 390  *     @defgroup kernel_sparc64_interrupt sparc64
 391  *     @ingroup interrupt
 392  *     @endcond
 393  */
 394
 395 /** @defgroup others Miscellanea
 396  * @ingroup kernel
 397  */
 398
 399 /**
 400  *     @defgroup kernel_generic generic
 401  *     @ingroup others
 402  */
 403
 404 /**
 405  *     @defgroup kernel_genarch genarch
 406  *     @ingroup others
 407  */
 408
 409 /**
 410  *     @cond abs32le
 411  *     @defgroup kernel_abs32le abs32le
 412  *     @ingroup others
 413  *     @endcond
 414  */
 415
 416 /**
 417  *     @cond amd64
 418  *     @defgroup kernel_amd64 amd64
 419  *     @ingroup others
 420  *     @endcond
 421  */
 422
 423 /**
 424  *     @cond arm32
 425  *     @defgroup kernel_arm32 arm32
 426  *     @ingroup others
 427  *     @endcond
 428  */
 429
 430 /**
 431  *     @cond ia32
 432  *     @defgroup kernel_ia32 ia32
 433  *     @ingroup others
 434  *     @endcond
 435  */
 436
 437 /**
 438  *     @cond ia64
 439  *     @defgroup kernel_ia64 ia64
 440  *     @ingroup others
 441  *     @endcond
 442  */
 443
 444 /**
 445  *     @cond mips32
 446  *     @defgroup kernel_mips32 mips32
 447  *     @ingroup others
 448  *     @endcond
 449  */
 450
 451 /**
 452  *     @cond ppc32
 453  *     @defgroup kernel_ppc32 ppc32
 454  *     @ingroup others
 455  *     @endcond
 456  */
 457
 458 /**
 459  *     @cond riscv64
 460  *     @defgroup kernel_riscv64 riscv64
 461  *     @ingroup others
 462  *     @endcond
 463  */
 464
 465 /**
 466  *     @cond sparc64
 467  *     @defgroup kernel_sparc64 sparc64
 468  *     @ingroup others
 469  *     @endcond
 470  */