source: mainline/uspace/doc/doxygroups.h@ f123909

lfn serial ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since f123909 was f123909, checked in by Jan Vesely <jano.vesely@…>, 14 years ago

Doxygen fixes and refactoring.

UHCI root hub driver should be complete (except may be for the BUG)
  • Property mode set to 100644
File size: 4.8 KB
Line 
1
2/* Definitions of modules and its relations for generating Doxygen documentation */
3
4/**
5 * @defgroup srvcs HelenOS Services
6 * @ingroup uspace
7 */
8
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 netif Network interface drivers
36 * @ingroup net
37 */
38
39 /**
40 * @defgroup lo Loopback Service
41 * @ingroup netif
42 */
43
44 /**
45 * @defgroup ne2000 NE2000 network interface service
46 * @ingroup netif
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
155 * @ingroup uspace
156 */
157
158 /**
159 * @defgroup sfl Softloat
160 * @ingroup emul
161 */
162
163 /**
164 * @defgroup softint Softint
165 * @ingroup emul
166 */
167
168/**
169 * @defgroup usb USB
170 * @ingroup uspace
171 * @brief USB support for HelenOS.
172 */
173 /**
174 * @defgroup libusb USB library
175 * @ingroup usb
176 * @brief Library for creating USB devices drivers.
177 */
178
179 /**
180 * @defgroup usbvirt USB virtualization
181 * @ingroup usb
182 * @brief Support for virtual USB devices.
183 */
184
185 /**
186 * @defgroup libusbvirt USB virtualization library
187 * @ingroup usbvirt
188 * @brief Library for creating virtual USB devices.
189 */
190
191 /**
192 * @defgroup drvusbvhc Virtual USB host controller
193 * @ingroup usbvirt
194 * @brief Driver simulating work of USB host controller.
195 */
196
197 /**
198 * @defgroup usbvirthub Virtual USB hub
199 * @ingroup usbvirt
200 * @brief Extra virtual USB hub for virtual host controller.
201 * @details
202 * Some of the sources are shared with virtual host controller,
203 * see @ref drvusbvhc for the rest of the files.
204 */
205
206 /**
207 * @defgroup usbvirtkbd Virtual USB keybaord
208 * @ingroup usbvirt
209 * @brief Virtual USB keyboard for virtual host controller.
210 */
211
212 /**
213 * @defgroup usbinfo USB info application
214 * @ingroup usb
215 * @brief Application for querying USB devices.
216 * @details
217 * The intended usage of this application is to query new USB devices
218 * for their descriptors etc. to simplify driver writing.
219 */
220
221 /**
222 * @defgroup drvusbmid USB multi interface device driver
223 * @ingroup usb
224 * @brief USB multi interface device driver
225 * @details
226 * This driver serves as a mini hub (or bus) driver for devices
227 * that have the class defined at interface level (those devices
228 * usually have several interfaces).
229 *
230 * The term multi interface device driver (MID) was borrowed
231 * Solaris operating system.
232 */
233
234 /**
235 * @defgroup drvusbhub USB hub driver
236 * @ingroup usb
237 * @brief USB hub driver.
238 */
239
240 /**
241 * @defgroup drvusbhid USB HID driver
242 * @ingroup usb
243 * @brief USB driver for HID devices.
244 */
245
246 /**
247 * @defgroup drvusbmouse USB mouse driver
248 * @ingroup usb
249 * @brief USB driver for mouse with boot protocol.
250 */
251
252 /**
253 * @defgroup drvusbuhci UHCI driver
254 * @ingroup usb
255 * @brief Drivers for USB UHCI host controller and root hub.
256 */
257
258 /**
259 * @defgroup drvusbuhcirh UHCI root hub driver
260 * @ingroup drvusbuhci
261 * @brief Driver for UHCI complaint root hub.
262 */
263
264 /**
265 * @defgroup drvusbehci EHCI driver
266 * @ingroup usb
267 * @brief Driver for EHCI host controller.
268 */
269
270
Note: See TracBrowser for help on using the repository browser.