Changeset 904b1bc in mainline for uspace/doc


Ignore:
Timestamp:
2018-05-22T10:36:58Z (7 years ago)
Author:
Jiri Svoboda <jiri@…>
Branches:
lfn, master, serial, ticket/834-toolchain-update, topic/msim-upgrade, topic/simplify-dev-export
Children:
a4eb3ba2
Parents:
4f8772d4
git-author:
Jiri Svoboda <jiri@…> (2018-05-21 17:36:30)
git-committer:
Jiri Svoboda <jiri@…> (2018-05-22 10:36:58)
Message:

Fix remaining ccheck issues.

Location:
uspace/doc
Files:
2 edited

Legend:

Unmodified
Added
Removed

  • uspace/doc/doxygroups.h

    r4f8772d4 r904b1bc  
    77 */
    88
    9         /**
    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         */
     9/**
     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 */
    152152
    153153/**
    … …  
    156156 */
    157157
    158         /**
    159          * @defgroup sfl Softloat
    160          * @ingroup emul
    161         */
    162 
    163         /**
    164          * @defgroup softint Softint
    165          * @ingroup emul
    166         */
     158/**
     159 *    @defgroup sfl Softloat
     160 *    @ingroup emul
     161 */
     162
     163/**
     164 *    @defgroup softint Softint
     165 *    @ingroup emul
     166 */
    167167
    168168/**
    … …  
    171171 * @brief USB support for HelenOS.
    172172 */
    173         /**
    174          * @defgroup libusb Base USB library
    175          * @ingroup usb
    176          * @brief Common definitions for any driver or application
    177          * dealing with USB.
    178          */
    179 
    180         /**
    181          * @defgroup libusbdev USB library for device drivers
    182          * @ingroup usb
    183          * @brief Library for writing drivers of endpoint devices (functions).
    184          */
    185 
    186         /**
    187          * @defgroup libusbhost USB library for host controller drivers
    188          * @ingroup usb
    189          * @brief Library for writing host controller drivers.
    190          */
    191 
    192         /**
    193          * @defgroup libusbhid USB library for HID devices
    194          * @ingroup usb
    195          * @brief Library for writing USB HID drivers.
    196          */
    197 
    198         /**
    199          * @defgroup usbvirt USB virtualization
    200          * @ingroup usb
    201          * @brief Support for virtual USB devices.
    202          */
    203 
    204                 /**
    205                  * @defgroup libusbvirt USB virtualization library
    206                  * @ingroup usbvirt
    207                  * @brief Library for creating virtual USB devices.
    208                  */
    209 
    210                 /**
    211                  * @defgroup drvusbvhc Virtual USB host controller
    212                  * @ingroup usbvirt
    213                  * @brief Driver simulating work of USB host controller.
    214                  */
    215 
    216                 /**
    217                  * @defgroup usbvirthub Virtual USB hub
    218                  * @ingroup usbvirt
    219                  * @brief Extra virtual USB hub for virtual host controller.
    220                  * @details
    221                  * Some of the sources are shared with virtual host controller,
    222                  * see @ref drvusbvhc for the rest of the files.
    223                  */
    224 
    225                 /**
    226                  * @defgroup usbvirtkbd Virtual USB keybaord
    227                  * @ingroup usbvirt
    228                  * @brief Virtual USB keyboard for virtual host controller.
    229                  */
    230 
    231         /**
    232          * @defgroup usbinfo USB info application
    233          * @ingroup usb
    234          * @brief Application for querying USB devices.
    235          * @details
    236          * The intended usage of this application is to query new USB devices
    237          * for their descriptors etc. to simplify driver writing.
    238          */
    239 
    240         /**
    241          * @defgroup lsusb HelenOS version of lsusb command
    242          * @ingroup usb
    243          * @brief Application for listing USB host controllers.
    244          * @details
    245          * List all found host controllers.
    246          */
    247 
    248         /**
    249          * @defgroup drvusbmid USB multi interface device driver
    250          * @ingroup usb
    251          * @brief USB multi interface device driver
    252          * @details
    253          * This driver serves as a mini hub (or bus) driver for devices
    254          * that have the class defined at interface level (those devices
    255          * usually have several interfaces).
    256          *
    257          * The term multi interface device driver (MID) was borrowed
    258          * Solaris operating system.
    259          */
    260 
    261         /**
    262          * @defgroup drvusbhub USB hub driver
    263          * @ingroup usb
    264          * @brief USB hub driver.
    265          */
    266 
    267         /**
    268          * @defgroup drvusbhid USB HID driver
    269          * @ingroup usb
    270          * @brief USB driver for HID devices.
    271          */
    272 
    273         /**
    274          * @defgroup drvusbmast USB mass storage driver
    275          * @ingroup usb
    276          * @brief USB driver for mass storage devices (bulk-only protocol).
    277          * This driver is a only a stub and is currently used only for
    278          * testing that bulk transfers work.
    279          */
    280 
    281         /**
    282          * @defgroup drvusbuhci UHCI driver
    283          * @ingroup usb
    284          * @brief Drivers for USB UHCI host controller and root hub.
    285          */
    286 
    287         /**
    288          * @defgroup drvusbohci OHCI driver
    289          * @ingroup usb
    290          * @brief Driver for OHCI host controller.
    291          */
    292 
    293         /**
    294          * @defgroup drvusbehci EHCI driver
    295          * @ingroup usb
    296          * @brief Driver for EHCI host controller.
    297          */
    298 
    299         /**
    300          * @defgroup drvusbfallback USB fallback driver
    301          * @ingroup usb
    302          * @brief Fallback driver for any USB device.
    303          * @details
    304          * The purpose of this driver is to simplify querying of unknown
    305          * devices from within HelenOS (without a driver, no node at all
    306          * may appear under /loc/devices).
    307          */
    308 
    309 
     173/**
     174 *     @defgroup libusb Base USB library
     175 *     @ingroup usb
     176 *     @brief Common definitions for any driver or application
     177 *     dealing with USB.
     178 */
     179
     180/**
     181 *     @defgroup libusbdev USB library for device drivers
     182 *     @ingroup usb
     183 *     @brief Library for writing drivers of endpoint devices (functions).
     184 */
     185
     186/**
     187 *     @defgroup libusbhost USB library for host controller drivers
     188 *     @ingroup usb
     189 *     @brief Library for writing host controller drivers.
     190 */
     191
     192/**
     193 *     @defgroup libusbhid USB library for HID devices
     194 *     @ingroup usb
     195 *     @brief Library for writing USB HID drivers.
     196 */
     197
     198/**
     199 *     @defgroup usbvirt USB virtualization
     200 *     @ingroup usb
     201 *     @brief Support for virtual USB devices.
     202 */
     203
     204/**
     205 *         @defgroup libusbvirt USB virtualization library
     206 *         @ingroup usbvirt
     207 *         @brief Library for creating virtual USB devices.
     208 */
     209
     210/**
     211 *         @defgroup drvusbvhc Virtual USB host controller
     212 *         @ingroup usbvirt
     213 *         @brief Driver simulating work of USB host controller.
     214 */
     215
     216/**
     217 *         @defgroup usbvirthub Virtual USB hub
     218 *         @ingroup usbvirt
     219 *         @brief Extra virtual USB hub for virtual host controller.
     220 *         @details
     221 *         Some of the sources are shared with virtual host controller,
     222 *         see @ref drvusbvhc for the rest of the files.
     223 */
     224
     225/**
     226 *         @defgroup usbvirtkbd Virtual USB keybaord
     227 *         @ingroup usbvirt
     228 *         @brief Virtual USB keyboard for virtual host controller.
     229 */
     230
     231/**
     232 *     @defgroup usbinfo USB info application
     233 *     @ingroup usb
     234 *     @brief Application for querying USB devices.
     235 *     @details
     236 *     The intended usage of this application is to query new USB devices
     237 *     for their descriptors etc. to simplify driver writing.
     238 */
     239
     240/**
     241 *     @defgroup lsusb HelenOS version of lsusb command
     242 *     @ingroup usb
     243 *     @brief Application for listing USB host controllers.
     244 *     @details
     245 *     List all found host controllers.
     246 */
     247
     248/**
     249 *     @defgroup drvusbmid USB multi interface device driver
     250 *     @ingroup usb
     251 *     @brief USB multi interface device driver
     252 *     @details
     253 *     This driver serves as a mini hub (or bus) driver for devices
     254 *     that have the class defined at interface level (those devices
     255 *     usually have several interfaces).
     256 *
     257 *     The term multi interface device driver (MID) was borrowed
     258 *     Solaris operating system.
     259 */
     260
     261/**
     262 *     @defgroup drvusbhub USB hub driver
     263 *     @ingroup usb
     264 *     @brief USB hub driver.
     265 */
     266
     267/**
     268 *     @defgroup drvusbhid USB HID driver
     269 *     @ingroup usb
     270 *     @brief USB driver for HID devices.
     271 */
     272
     273/**
     274 *     @defgroup drvusbmast USB mass storage driver
     275 *     @ingroup usb
     276 *     @brief USB driver for mass storage devices (bulk-only protocol).
     277 *     This driver is a only a stub and is currently used only for
     278 *     testing that bulk transfers work.
     279 */
     280
     281/**
     282 *     @defgroup drvusbuhci UHCI driver
     283 *     @ingroup usb
     284 *     @brief Drivers for USB UHCI host controller and root hub.
     285 */
     286
     287/**
     288 *     @defgroup drvusbohci OHCI driver
     289 *     @ingroup usb
     290 *     @brief Driver for OHCI host controller.
     291 */
     292
     293/**
     294 *     @defgroup drvusbehci EHCI driver
     295 *     @ingroup usb
     296 *     @brief Driver for EHCI host controller.
     297 */
     298
     299/**
     300 *     @defgroup drvusbfallback USB fallback driver
     301 *     @ingroup usb
     302 *     @brief Fallback driver for any USB device.
     303 *     @details
     304 *     The purpose of this driver is to simplify querying of unknown
     305 *     devices from within HelenOS (without a driver, no node at all
     306 *     may appear under /loc/devices).
     307 */

  • uspace/doc/main_page.h

    r4f8772d4 r904b1bc  
    11/**
    2  @mainpage HelenOS Operating System Source Code Reference
    3 
    4 HelenOS is a portable microkernel-based multiserver operating system designed and implemented from scratch. It decomposes key operating system functionality such as file systems, networking, device drivers and graphical user interface into a collection of fine-grained user space components that interact with each other via message passing. A failure or crash of one component does not directly harm others. HelenOS is therefore flexible, modular, extensible, fault tolerant and easy to understand.
    5 
    6 HelenOS does not aim to be a clone of any existing operating system and trades compatibility with legacy APIs for cleaner design. Most of HelenOS components have been made to order specifically for HelenOS so that its essential parts can stay free of adaptation layers, glue code, franken-components and the maintenance burden incurred by them.
    7 
    8 HelenOS runs on seven different processor architectures and machines ranging from embedded ARM devices and single-board computers through multicore 32-bit and 64-bit desktop PCs to 64-bit Itanium and SPARC rack-mount servers.
    9 
    10 HelenOS is open source, free software. Its source code is available under the BSD license. Some third-party components are licensed under GPL.
    11 
    12 */
     2 * @mainpage HelenOS Operating System Source Code Reference
     3 *
     4 * HelenOS is a portable microkernel-based multiserver operating system designed and implemented from scratch. It decomposes key operating system functionality such as file systems, networking, device drivers and graphical user interface into a collection of fine-grained user space components that interact with each other via message passing. A failure or crash of one component does not directly harm others. HelenOS is therefore flexible, modular, extensible, fault tolerant and easy to understand.
     5 *
     6 * HelenOS does not aim to be a clone of any existing operating system and trades compatibility with legacy APIs for cleaner design. Most of HelenOS components have been made to order specifically for HelenOS so that its essential parts can stay free of adaptation layers, glue code, franken-components and the maintenance burden incurred by them.
     7 *
     8 * HelenOS runs on seven different processor architectures and machines ranging from embedded ARM devices and single-board computers through multicore 32-bit and 64-bit desktop PCs to 64-bit Itanium and SPARC rack-mount servers.
     9 *
     10 * HelenOS is open source, free software. Its source code is available under the BSD license. Some third-party components are licensed under GPL.
     11 *
     12 */
Note: See TracChangeset for help on using the changeset viewer.