diff options
author | Christian Grothoff <christian@grothoff.org> | 2013-08-22 07:01:16 +0000 |
---|---|---|
committer | Christian Grothoff <christian@grothoff.org> | 2013-08-22 07:01:16 +0000 |
commit | 404892a3b6e5f58554088f8d869234aedbdfc296 (patch) | |
tree | ccbf5442fbd9161514d71801c322e05e40555f4a | |
parent | 4f6aa30eb0bb5ffe9052e4a87aefef2d16d33868 (diff) | |
download | libmicrohttpd-404892a3b6e5f58554088f8d869234aedbdfc296.tar.gz libmicrohttpd-404892a3b6e5f58554088f8d869234aedbdfc296.zip |
-more doxygen improvements
-rw-r--r-- | doc/doxygen/libmicrohttpd.doxy | 2 | ||||
-rw-r--r-- | src/include/microhttpd.h | 49 |
2 files changed, 33 insertions, 18 deletions
diff --git a/doc/doxygen/libmicrohttpd.doxy b/doc/doxygen/libmicrohttpd.doxy index 01f2348d..01a66d74 100644 --- a/doc/doxygen/libmicrohttpd.doxy +++ b/doc/doxygen/libmicrohttpd.doxy | |||
@@ -98,7 +98,7 @@ FILE_PATTERNS = *.c \ | |||
98 | RECURSIVE = YES | 98 | RECURSIVE = YES |
99 | EXCLUDE = | 99 | EXCLUDE = |
100 | EXCLUDE_SYMLINKS = NO | 100 | EXCLUDE_SYMLINKS = NO |
101 | EXCLUDE_PATTERNS = */test_* */.svn/* */perf_* | 101 | EXCLUDE_PATTERNS = */test_* */.svn/* */perf_* */tls_test_* */examples/* */testcurl/* */testspdy/* */testzzuf/* */plibc/* */symbian/* MHD_config.h |
102 | EXCLUDE_SYMBOLS = MHD_DLOG | 102 | EXCLUDE_SYMBOLS = MHD_DLOG |
103 | EXAMPLE_PATH = | 103 | EXAMPLE_PATH = |
104 | EXAMPLE_PATTERNS = * | 104 | EXAMPLE_PATTERNS = * |
diff --git a/src/include/microhttpd.h b/src/include/microhttpd.h index 7fda89de..454f457f 100644 --- a/src/include/microhttpd.h +++ b/src/include/microhttpd.h | |||
@@ -69,11 +69,18 @@ | |||
69 | * failing) to include the right headers. | 69 | * failing) to include the right headers. |
70 | * | 70 | * |
71 | * @defgroup event event-loop control | 71 | * @defgroup event event-loop control |
72 | * MHD API to start and stop the HTTP server and manage the event loop. | ||
72 | * @defgroup response generation of responses | 73 | * @defgroup response generation of responses |
74 | * MHD API used to generate responses. | ||
73 | * @defgroup request handling of requests | 75 | * @defgroup request handling of requests |
76 | * MHD API used to access information about requests. | ||
74 | * @defgroup authentication HTTP authentication | 77 | * @defgroup authentication HTTP authentication |
75 | * @defgroup logging logging and error handling | 78 | * MHD API related to basic and digest HTTP authentication. |
79 | * @defgroup logging logging | ||
80 | * MHD API to mange logging and error handling | ||
76 | * @defgroup specialized misc. specialized functions | 81 | * @defgroup specialized misc. specialized functions |
82 | * This group includes functions that do not fit into any particular | ||
83 | * category and that are rarely used. | ||
77 | */ | 84 | */ |
78 | 85 | ||
79 | #ifndef MHD_MICROHTTPD_H | 86 | #ifndef MHD_MICROHTTPD_H |
@@ -175,6 +182,7 @@ extern "C" | |||
175 | 182 | ||
176 | /** | 183 | /** |
177 | * @defgroup httpcode HTTP response codes. | 184 | * @defgroup httpcode HTTP response codes. |
185 | * These are the status codes defined for HTTP responses. | ||
178 | * @{ | 186 | * @{ |
179 | */ | 187 | */ |
180 | #define MHD_HTTP_CONTINUE 100 | 188 | #define MHD_HTTP_CONTINUE 100 |
@@ -250,6 +258,7 @@ extern "C" | |||
250 | 258 | ||
251 | /** | 259 | /** |
252 | * @defgroup headers HTTP headers | 260 | * @defgroup headers HTTP headers |
261 | * These are the standard headers found in HTTP requests and responses. | ||
253 | * @{ | 262 | * @{ |
254 | */ | 263 | */ |
255 | /* See also: http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html */ | 264 | /* See also: http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html */ |
@@ -308,8 +317,9 @@ extern "C" | |||
308 | /** @} */ /* end of group headers */ | 317 | /** @} */ /* end of group headers */ |
309 | 318 | ||
310 | /** | 319 | /** |
311 | * @defgroup versions HTTP versions (used to match against the first line of the | 320 | * @defgroup versions HTTP versions |
312 | * HTTP header as well as in the response code). | 321 | * These strings should be used to match against the first line of the |
322 | * HTTP header. | ||
313 | * @{ | 323 | * @{ |
314 | */ | 324 | */ |
315 | #define MHD_HTTP_VERSION_1_0 "HTTP/1.0" | 325 | #define MHD_HTTP_VERSION_1_0 "HTTP/1.0" |
@@ -319,6 +329,7 @@ extern "C" | |||
319 | 329 | ||
320 | /** | 330 | /** |
321 | * @defgroup methods HTTP methods | 331 | * @defgroup methods HTTP methods |
332 | * Standard HTTP methods (as strings). | ||
322 | * @{ | 333 | * @{ |
323 | */ | 334 | */ |
324 | #define MHD_HTTP_METHOD_CONNECT "CONNECT" | 335 | #define MHD_HTTP_METHOD_CONNECT "CONNECT" |
@@ -333,8 +344,8 @@ extern "C" | |||
333 | /** @} */ /* end of group methods */ | 344 | /** @} */ /* end of group methods */ |
334 | 345 | ||
335 | /** | 346 | /** |
336 | * @defgroup postenc HTTP POST encodings, see also | 347 | * @defgroup postenc HTTP POST encodings |
337 | * http://www.w3.org/TR/html4/interact/forms.html#h-17.13.4 | 348 | * See also: http://www.w3.org/TR/html4/interact/forms.html#h-17.13.4 |
338 | * @{ | 349 | * @{ |
339 | */ | 350 | */ |
340 | #define MHD_HTTP_POST_ENCODING_FORM_URLENCODED "application/x-www-form-urlencoded" | 351 | #define MHD_HTTP_POST_ENCODING_FORM_URLENCODED "application/x-www-form-urlencoded" |
@@ -344,38 +355,40 @@ extern "C" | |||
344 | 355 | ||
345 | 356 | ||
346 | /** | 357 | /** |
347 | * Handle for the daemon (listening on a socket for HTTP traffic). | 358 | * @brief Handle for the daemon (listening on a socket for HTTP traffic). |
348 | * @ingroup event | 359 | * @ingroup event |
349 | */ | 360 | */ |
350 | struct MHD_Daemon; | 361 | struct MHD_Daemon; |
351 | 362 | ||
352 | /** | 363 | /** |
353 | * Handle for a connection / HTTP request. With HTTP/1.1, multiple | 364 | * @brief Handle for a connection / HTTP request. |
354 | * requests can be run over the same connection. However, MHD will | 365 | * |
355 | * only show one request per TCP connection to the client at any given | 366 | * With HTTP/1.1, multiple requests can be run over the same |
356 | * time. | 367 | * connection. However, MHD will only show one request per TCP |
368 | * connection to the client at any given time. | ||
357 | * @ingroup request | 369 | * @ingroup request |
358 | */ | 370 | */ |
359 | struct MHD_Connection; | 371 | struct MHD_Connection; |
360 | 372 | ||
361 | /** | 373 | /** |
362 | * Handle for a response. | 374 | * @brief Handle for a response. |
363 | * @ingroup response | 375 | * @ingroup response |
364 | */ | 376 | */ |
365 | struct MHD_Response; | 377 | struct MHD_Response; |
366 | 378 | ||
367 | /** | 379 | /** |
368 | * Handle for POST processing. | 380 | * @brief Handle for POST processing. |
369 | * @ingroup response | 381 | * @ingroup response |
370 | */ | 382 | */ |
371 | struct MHD_PostProcessor; | 383 | struct MHD_PostProcessor; |
372 | 384 | ||
373 | 385 | ||
374 | /** | 386 | /** |
375 | * Options for the MHD daemon. Note that if neither | 387 | * @brief Flags for the `struct MHD_Daemon`. |
376 | * #MHD_USE_THREAD_PER_CONNECTION nor #MHD_USE_SELECT_INTERNALLY is | 388 | * |
377 | * used, the client wants control over the process and will call the | 389 | * Note that if neither #MHD_USE_THREAD_PER_CONNECTION nor |
378 | * appropriate microhttpd callbacks. | 390 | * #MHD_USE_SELECT_INTERNALLY is used, the client wants control over |
391 | * the process and will call the appropriate microhttpd callbacks. | ||
379 | * | 392 | * |
380 | * Starting the daemon may also fail if a particular option is not | 393 | * Starting the daemon may also fail if a particular option is not |
381 | * implemented or not supported on the target platform (i.e. no | 394 | * implemented or not supported on the target platform (i.e. no |
@@ -520,7 +533,9 @@ typedef void (*MHD_LogCallback)(void *cls, const char *fm, va_list ap); | |||
520 | 533 | ||
521 | 534 | ||
522 | /** | 535 | /** |
523 | * MHD options. Passed in the varargs portion of #MHD_start_daemon. | 536 | * @brief MHD options. |
537 | * | ||
538 | * Passed in the varargs portion of #MHD_start_daemon. | ||
524 | */ | 539 | */ |
525 | enum MHD_OPTION | 540 | enum MHD_OPTION |
526 | { | 541 | { |