comparison scid/page-api-jobs.h @ 33:1d0ddf9e6efd

misc: general documentation
author David Demelier <markand@malikania.fr>
date Thu, 04 Aug 2022 16:47:10 +0200
parents 081e1c258e64
children 71cd8447e3a4
comparison
equal deleted inserted replaced
32:081e1c258e64 33:1d0ddf9e6efd
1 /* 1 /*
2 * page-api-jobs.h -- /api/v?/jobs route 2 * page-api-jobs.h -- page /api/v?/jobs route
3 * 3 *
4 * Copyright (c) 2021-2022 David Demelier <markand@malikania.fr> 4 * Copyright (c) 2021-2022 David Demelier <markand@malikania.fr>
5 * 5 *
6 * Permission to use, copy, modify, and/or distribute this software for any 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 7 * purpose with or without fee is hereby granted, provided that the above
17 */ 17 */
18 18
19 #ifndef SCI_PAGE_API_JOBS_H 19 #ifndef SCI_PAGE_API_JOBS_H
20 #define SCI_PAGE_API_JOBS_H 20 #define SCI_PAGE_API_JOBS_H
21 21
22 /**
23 * \file page-api-jobs.h
24 * \brief Page /api/v?/jobs route.
25 *
26 * This module logs message with tag `page-api-jobs`.
27 */
28
22 struct kreq; 29 struct kreq;
23 30
31 /**
32 * Run the page.
33 *
34 * \pre r != NULL
35 * \param r the request
36 */
24 void 37 void
25 page_api_v1_jobs(struct kreq *); 38 page_api_v1_jobs(struct kreq *r);
26 39
27 #endif /* !SCI_PAGE_API_JOBS_H */ 40 #endif /* !SCI_PAGE_API_JOBS_H */