@@ -84,10 +84,10 @@ struct sol_http_progressive_response;
8484 * in the specified @a port.
8585 *
8686 * With the returned handle it's possible to register paths using
87- * @c sol_http_server_register_handler
88- * and dirs with @c sol_http_server_add_dir.
87+ * @c sol_http_server_register_handler()
88+ * and dirs with @c sol_http_server_add_dir() .
8989 *
90- * @note Only one instance of sol_http_server is possible per port.
90+ * @note Only one instance of @c sol_http_server is possible per port.
9191 * Try to run a second instance in the
9292 * same port will result in fail.
9393 *
@@ -100,14 +100,14 @@ struct sol_http_server *sol_http_server_new(uint16_t port);
100100/**
101101 * @brief Destroy the @a server instance.
102102 *
103- * @param server The value got with @c sol_http_server_new
103+ * @param server The value got with @c sol_http_server_new()
104104 */
105105void sol_http_server_del (struct sol_http_server * server );
106106
107107/**
108108 * @brief Register a handler for a specific path.
109109 *
110- * @param server The value got with @c sol_http_server_new
110+ * @param server The value got with @c sol_http_server_new()
111111 * @param path The path where the handler will serve, it means, when a request comes in this path the
112112 * callback set will be called and a response should be sent back
113113 * @param request_cb The callback for the request received on the specified path
@@ -120,10 +120,10 @@ int sol_http_server_register_handler(struct sol_http_server *server, const char
120120 const void * data );
121121
122122/**
123- * @brief Removes a handler registered with @c sol_http_server_register_handler
123+ * @brief Removes a handler registered with @c sol_http_server_register_handler()
124124 *
125125 * @param server The value got with @c sol_http_server_new
126- * @param path The same path given on @c sol_http_server_register_handler
126+ * @param path The same path given on @c sol_http_server_register_handler()
127127 *
128128 * @return @c 0 on success, error code (always negative) otherwise.
129129 */
@@ -137,7 +137,7 @@ int sol_http_server_unregister_handler(struct sol_http_server *server, const cha
137137 * root dirs set. The response will be sent as soon as a file matches
138138 * with the request.
139139 *
140- * @param server The value got with @c sol_http_server_new
140+ * @param server The value got with @c sol_http_server_new()
141141 * @param basename The base path of the requests where the server will
142142 * look for files on @c rootdir
143143 * @param rootdir The dir where the server will look for static files
@@ -147,11 +147,11 @@ int sol_http_server_unregister_handler(struct sol_http_server *server, const cha
147147int sol_http_server_add_dir (struct sol_http_server * server , const char * basename , const char * rootdir );
148148
149149/**
150- * @brief Removes a dir registered with @c sol_http_server_add_dir
150+ * @brief Removes a dir registered with @c sol_http_server_add_dir()
151151 *
152- * @param server The value got with @c sol_http_server_new
153- * @param basename The same basename given on @c sol_http_server_add_dir
154- * @param rootdir The same rootdir given on @c sol_http_server_add_dir
152+ * @param server The value got with @c sol_http_server_new()
153+ * @param basename The same basename given on @c sol_http_server_add_dir()
154+ * @param rootdir The same rootdir given on @c sol_http_server_add_dir()
155155 *
156156 * @return @c 0 on success, error code (always negative) otherwise.
157157 */
@@ -162,7 +162,7 @@ int sol_http_server_remove_dir(struct sol_http_server *server, const char *basen
162162/**
163163 * @brief Add a page for a specific error code
164164 *
165- * @param server The value got with @c sol_http_server_new
165+ * @param server The value got with @c sol_http_server_new()
166166 * @param error The error code which @page_path will be served
167167 * @param page The path to a html file
168168 *
@@ -173,11 +173,11 @@ int sol_http_server_set_error_page(struct sol_http_server *server,
173173
174174/**
175175 * @brief Removes a default error page registered with
176- * @c sol_http_server_add_default_error_page
176+ * @c sol_http_server_add_default_error_page()
177177 *
178- * @param server The value got with @c sol_http_server_new
178+ * @param server The value got with @c sol_http_server_new()
179179 * @param error The same error given on
180- * @c sol_http_server_add_default_error_page
180+ * @c sol_http_server_add_default_error_page()
181181 *
182182 * @return @c 0 on success, error code (always negative) otherwise.
183183 */
@@ -196,8 +196,8 @@ int sol_http_server_remove_error_page(struct sol_http_server *server,
196196 *
197197 * @note: This is specific per @a server/@a path.
198198 *
199- * @param server The value got with @c sol_http_server_new
200- * @param path The same path given on @c sol_http_server_register_handler
199+ * @param server The value got with @c sol_http_server_new()
200+ * @param path The same path given on @c sol_http_server_register_handler()
201201 * @param modified The time it was modified
202202 *
203203 * @return @c 0 on success, error code (always negative) otherwise.
@@ -206,12 +206,12 @@ int sol_http_server_set_last_modified(struct sol_http_server *server, const char
206206
207207/**
208208 * @brief Send the response to request given in the callback registered on
209- * @c sol_http_server_register_handler.
209+ * @c sol_http_server_register_handler() .
210210 *
211211 * After this call, @a request should not be used anymore.
212212 *
213213 * @param request The request given on the callback of
214- * @c sol_http_server_register_handler
214+ * @c sol_http_server_register_handler()
215215 * @param response The response for the request containing the data
216216 * and parameters (e.g http headers)
217217 *
@@ -363,7 +363,7 @@ int sol_http_request_get_client_address(const struct sol_http_request *request,
363363 * This function changes the default request's buffer size, it is
364364 * used to store the post data. The default value is 4096 bytes.
365365 *
366- * @param server The handle got with @c sol_http_server_new
366+ * @param server The handle got with @c sol_http_server_new()
367367 * @param buf_size The size of the buffer.
368368 *
369369 * @return 0 in success, a negative value otherwise.
@@ -375,12 +375,12 @@ int sol_http_server_set_buffer_size(struct sol_http_server *server, size_t buf_s
375375/**
376376 * @brief Get the request buffer's size.
377377 *
378- * @param server The handle got with @c sol_http_server_new
378+ * @param server The handle got with @c sol_http_server_new()
379379 * @param buf_size Variable to get the buffer's size.
380380 *
381381 * @return 0 in success, a negative value otherwise.
382382 *
383- * @see sol_http_server_set_buffer_size
383+ * @see sol_http_server_set_buffer_size()
384384 */
385385int sol_http_server_get_buffer_size (struct sol_http_server * server , size_t * buf_size );
386386
0 commit comments