Changeset 4122410 in mainline for uspace/doc/doxygroups.h


Ignore:
Timestamp:
2018-08-29T21:26:21Z (7 years ago)
Author:
Jakub Jermar <jakub@…>
Branches:
lfn, master, serial, ticket/834-toolchain-update, topic/msim-upgrade, topic/simplify-dev-export
Children:
c8ea6eca
Parents:
46f7b64
Message:

Improve Doxygen documentaion

This is stil WiP. A number of libraries, drivers and services were
converted to using a more hierarchical and decentralized scheme when it
comes to specifying to which doxygen group they belong.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • uspace/doc/doxygroups.h

    r46f7b64 r4122410  
    33
    44/**
    5  * @defgroup srvcs HelenOS Services
     5 * @defgroup uspace Userspace
     6 * @brief All HelenOS userspace code
     7 */
     8
     9/**
     10 * @defgroup apps HelenOS applications
    611 * @ingroup uspace
    712 */
    813
    914/**
    10  *     @defgroup ns Naming Service
    11  *     @ingroup srvcs
    12  */
    13 
    14 /**
    15  *     @defgroup kbd Keyboard Service
    16  *     @ingroup srvcs
    17  */
    18 
    19 /**
    20  *     @defgroup fbs Framebuffer Service
    21  *     @ingroup srvcs
    22  */
    23 
    24 /**
    25  *     @defgroup console Console Service
    26  *     @ingroup srvcs
    27  */
    28 
    29 /**
    30  *     @defgroup net Networking Stack
    31  *     @ingroup srvcs
    32  */
    33 
    34 /**
    35  *         @defgroup nic Network interface controllers
    36  *         @ingroup net
    37  */
    38 
    39 /**
    40  *             @defgroup libnic Base NIC framework library
    41  *             @ingroup nic
    42  */
    43 
    44 /**
    45  *             @defgroup nic_drivers Drivers using the NICF
    46  *             @ingroup nic
    47  */
    48 
    49 /**
    50  *         @defgroup net_nil Network interface layer
    51  *         @ingroup net
    52  */
    53 
    54 /**
    55  *             @defgroup eth Ethernet (IEEE 802.3) network interface layer Service
    56  *             @ingroup net_nil
    57  */
    58 
    59 /**
    60  *             @defgroup nildummy Dummy network interface layer Service
    61  *             @ingroup net_nil
    62  */
    63 
    64 /**
    65  *         @defgroup net_il Inter-networking layer
    66  *         @ingroup net
    67  */
    68 
    69 /**
    70  *             @defgroup arp Address Resolution Protocol (ARP) Service
    71  *             @ingroup net_il
    72  */
    73 
    74 /**
    75  *             @defgroup ip Internet Protocol (IP) Service
    76  *             @ingroup net_il
    77  */
    78 
    79 /**
    80  *         @defgroup net_tl Transport layer
    81  *         @ingroup net
    82  */
    83 
    84 /**
    85  *             @defgroup icmp Internet Control Message Protocol (ICMP) Service
    86  *             @ingroup net_tl
    87  */
    88 
    89 /**
    90  *             @defgroup udp User Datagram Protocol (UDP) Service
    91  *             @ingroup net_tl
    92  */
    93 
    94 /**
    95  *             @defgroup tcp Transmission Control Protocol (TCP) Service
    96  *             @ingroup net_tl
    97  */
    98 
    99 /**
    100  *         @defgroup packet Packet management system
    101  *         @ingroup net
    102  */
    103 
    104 /**
    105  *         @defgroup net_app Applications
    106  *         @ingroup net
    107  */
    108 
    109 /**
    110  *             @defgroup echo Echo Service
    111  *             @ingroup net_app
    112  */
    113 
    114 /**
    115  *             @defgroup ping Ping
    116  *             @ingroup net_app
    117  */
    118 
    119 /**
    120  *             @defgroup nettest Networking tests
    121  *             @ingroup net_app
    122  */
    123 
    124 /**
    125  *         @defgroup net_lib Application library
    126  *         @ingroup net
    127  */
    128 
    129 /**
    130  *             @defgroup socket Sockets
    131  *             @ingroup net_lib
    132  */
    133 
    134 /**
    135  *             @defgroup netdb Netdb
    136  *             @ingroup net_lib
    137  */
    138 
    139 /**
    140  *     @cond amd64
    141  *     @defgroup pci PCI Service
    142  *     @ingroup srvcs
    143  *     @endcond
    144  */
    145 
    146 /**
    147  *     @cond ia32
    148  *     @defgroup pci PCI Service
    149  *     @ingroup srvcs
    150  *     @endcond
    151  */
    152 
    153 /**
    154  * @defgroup emul Emulation Libraries
     15 * @defgroup drvs HelenOS drivers
     16 * @brief HelenOS device drivers using the DDF framework
    15517 * @ingroup uspace
    15618 */
    15719
    15820/**
    159  *     @defgroup sfl Softloat
    160  *     @ingroup emul
     21 * @defgroup libs HelenOS libraries
     22 * @ingroup uspace
    16123 */
    16224
    16325/**
    164  *     @defgroup softint Softint
    165  *     @ingroup emul
     26 * @defgroup srvs HelenOS services
     27 * @ingroup uspace
     28 */
     29
     30
     31/*
     32 * SPECIAL COMPOSITIONS
    16633 */
    16734
    … …  
    17138 * @brief USB support for HelenOS.
    17239 */
     40
    17341/**
    17442 *     @defgroup libusb Base USB library
Note: See TracChangeset for help on using the changeset viewer.