annotate scid/page-index.h @ 77:070d8c92ca30

scid: fix index page
author David Demelier <markand@malikania.fr>
date Mon, 30 Jan 2023 10:38:33 +0100
parents 1d0ddf9e6efd
children 71cd8447e3a4
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
26
7e10cace67a3 scid: add basic mustache support
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 /*
33
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
2 * page-index.h -- page / route
26
7e10cace67a3 scid: add basic mustache support
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 *
32
081e1c258e64 misc: update copyright years
David Demelier <markand@malikania.fr>
parents: 26
diff changeset
4 * Copyright (c) 2021-2022 David Demelier <markand@malikania.fr>
26
7e10cace67a3 scid: add basic mustache support
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 *
7e10cace67a3 scid: add basic mustache support
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 * Permission to use, copy, modify, and/or distribute this software for any
7e10cace67a3 scid: add basic mustache support
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 * purpose with or without fee is hereby granted, provided that the above
7e10cace67a3 scid: add basic mustache support
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 * copyright notice and this permission notice appear in all copies.
7e10cace67a3 scid: add basic mustache support
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 *
7e10cace67a3 scid: add basic mustache support
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
7e10cace67a3 scid: add basic mustache support
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
7e10cace67a3 scid: add basic mustache support
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
7e10cace67a3 scid: add basic mustache support
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
7e10cace67a3 scid: add basic mustache support
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
7e10cace67a3 scid: add basic mustache support
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
7e10cace67a3 scid: add basic mustache support
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
7e10cace67a3 scid: add basic mustache support
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 */
7e10cace67a3 scid: add basic mustache support
David Demelier <markand@malikania.fr>
parents:
diff changeset
18
7e10cace67a3 scid: add basic mustache support
David Demelier <markand@malikania.fr>
parents:
diff changeset
19 #ifndef SCI_PAGE_INDEX_H
7e10cace67a3 scid: add basic mustache support
David Demelier <markand@malikania.fr>
parents:
diff changeset
20 #define SCI_PAGE_INDEX_H
7e10cace67a3 scid: add basic mustache 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-index.h
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
24 * \brief Page / 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 does not log messages.
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
26
7e10cace67a3 scid: add basic mustache support
David Demelier <markand@malikania.fr>
parents:
diff changeset
29 struct kreq;
7e10cace67a3 scid: add basic mustache 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 */
26
7e10cace67a3 scid: add basic mustache 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_index(struct kreq *r);
26
7e10cace67a3 scid: add basic mustache support
David Demelier <markand@malikania.fr>
parents:
diff changeset
39
7e10cace67a3 scid: add basic mustache support
David Demelier <markand@malikania.fr>
parents:
diff changeset
40 #endif /* !SCI_PAGE_INDEX_H */