annotate scid/page-api-todo.h @ 57:bc617784ec97

scid: many fixes in pages
author David Demelier <markand@malikania.fr>
date Wed, 17 Aug 2022 18:26:27 +0200
parents 1d0ddf9e6efd
children 71cd8447e3a4
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
16
3051ef92173a misc: add license headers
David Demelier <markand@malikania.fr>
parents: 2
diff changeset
1 /*
33
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
2 * page-api-todo.h -- page /api/v?/todo route
16
3051ef92173a misc: add license headers
David Demelier <markand@malikania.fr>
parents: 2
diff changeset
3 *
32
081e1c258e64 misc: update copyright years
David Demelier <markand@malikania.fr>
parents: 20
diff changeset
4 * Copyright (c) 2021-2022 David Demelier <markand@malikania.fr>
16
3051ef92173a misc: add license headers
David Demelier <markand@malikania.fr>
parents: 2
diff changeset
5 *
3051ef92173a misc: add license headers
David Demelier <markand@malikania.fr>
parents: 2
diff changeset
6 * Permission to use, copy, modify, and/or distribute this software for any
3051ef92173a misc: add license headers
David Demelier <markand@malikania.fr>
parents: 2
diff changeset
7 * purpose with or without fee is hereby granted, provided that the above
3051ef92173a misc: add license headers
David Demelier <markand@malikania.fr>
parents: 2
diff changeset
8 * copyright notice and this permission notice appear in all copies.
3051ef92173a misc: add license headers
David Demelier <markand@malikania.fr>
parents: 2
diff changeset
9 *
3051ef92173a misc: add license headers
David Demelier <markand@malikania.fr>
parents: 2
diff changeset
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
3051ef92173a misc: add license headers
David Demelier <markand@malikania.fr>
parents: 2
diff changeset
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
3051ef92173a misc: add license headers
David Demelier <markand@malikania.fr>
parents: 2
diff changeset
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
3051ef92173a misc: add license headers
David Demelier <markand@malikania.fr>
parents: 2
diff changeset
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
3051ef92173a misc: add license headers
David Demelier <markand@malikania.fr>
parents: 2
diff changeset
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
3051ef92173a misc: add license headers
David Demelier <markand@malikania.fr>
parents: 2
diff changeset
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
3051ef92173a misc: add license headers
David Demelier <markand@malikania.fr>
parents: 2
diff changeset
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
3051ef92173a misc: add license headers
David Demelier <markand@malikania.fr>
parents: 2
diff changeset
17 */
3051ef92173a misc: add license headers
David Demelier <markand@malikania.fr>
parents: 2
diff changeset
18
20
f98ea578b1ef misc: revamp database
David Demelier <markand@malikania.fr>
parents: 18
diff changeset
19 #ifndef SCI_PAGE_API_TODO_H
f98ea578b1ef misc: revamp database
David Demelier <markand@malikania.fr>
parents: 18
diff changeset
20 #define SCI_PAGE_API_TODO_H
2
5fa3d2f479b2 sci: initial upload support
David Demelier <markand@malikania.fr>
parents:
diff changeset
21
33
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
22 /**
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
23 * \file page-api-todo.h
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
24 * \brief Page /api/v?/todo route.
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
25 *
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
26 * This module logs message with tag `page-api-todo`.
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
27 */
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
28
2
5fa3d2f479b2 sci: initial upload support
David Demelier <markand@malikania.fr>
parents:
diff changeset
29 struct kreq;
5fa3d2f479b2 sci: initial upload support
David Demelier <markand@malikania.fr>
parents:
diff changeset
30
33
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
31 /**
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
32 * Run the page.
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
33 *
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
34 * \pre r != NULL
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
35 * \param r the request
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
36 */
2
5fa3d2f479b2 sci: initial upload support
David Demelier <markand@malikania.fr>
parents:
diff changeset
37 void
33
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
38 page_api_v1_todo(struct kreq *r);
2
5fa3d2f479b2 sci: initial upload support
David Demelier <markand@malikania.fr>
parents:
diff changeset
39
20
f98ea578b1ef misc: revamp database
David Demelier <markand@malikania.fr>
parents: 18
diff changeset
40 #endif /* !SCI_PAGE_API_TODO_H */