Mercurial > sci
comparison scid/page-api-workers.h @ 33:1d0ddf9e6efd
misc: general documentation
author | David Demelier <markand@malikania.fr> |
---|---|
date | Thu, 04 Aug 2022 16:47:10 +0200 |
parents | 600204c31bf0 |
children | 71cd8447e3a4 |
comparison
equal
deleted
inserted
replaced
32:081e1c258e64 | 33:1d0ddf9e6efd |
---|---|
1 /* | |
2 * page-api-workers.h -- page /api/v?/workers route | |
3 * | |
4 * Copyright (c) 2021-2022 David Demelier <markand@malikania.fr> | |
5 * | |
6 * Permission to use, copy, modify, and/or distribute this software for any | |
7 * purpose with or without fee is hereby granted, provided that the above | |
8 * copyright notice and this permission notice appear in all copies. | |
9 * | |
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES | |
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF | |
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR | |
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES | |
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN | |
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF | |
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. | |
17 */ | |
18 | |
1 #ifndef SCI_PAGE_API_WORKERS_H | 19 #ifndef SCI_PAGE_API_WORKERS_H |
2 #define SCI_PAGE_API_WORKERS_H | 20 #define SCI_PAGE_API_WORKERS_H |
3 | 21 |
22 /** | |
23 * \file page-api-workers.h | |
24 * \brief Page /api/v?/workers route. | |
25 * | |
26 * This module logs message with tag `page-api-workers`. | |
27 */ | |
28 | |
4 struct kreq; | 29 struct kreq; |
5 | 30 |
31 /** | |
32 * Run the page. | |
33 * | |
34 * \pre r != NULL | |
35 * \param r the request | |
36 */ | |
6 void | 37 void |
7 page_api_v1_workers(struct kreq *); | 38 page_api_v1_workers(struct kreq *r); |
8 | 39 |
9 #endif /* !SCI_PAGE_API_WORKERS_H */ | 40 #endif /* !SCI_PAGE_API_WORKERS_H */ |