annotate scid/page-api-jobresults.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
24
34cbbd215ef7 misc: add basic support for jobresults
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-api-jobresults.h -- page /api/v?/jobresults route
24
34cbbd215ef7 misc: add basic support for jobresults
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 *
32
081e1c258e64 misc: update copyright years
David Demelier <markand@malikania.fr>
parents: 24
diff changeset
4 * Copyright (c) 2021-2022 David Demelier <markand@malikania.fr>
24
34cbbd215ef7 misc: add basic support for jobresults
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 *
34cbbd215ef7 misc: add basic support for jobresults
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 * Permission to use, copy, modify, and/or distribute this software for any
34cbbd215ef7 misc: add basic support for jobresults
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 * purpose with or without fee is hereby granted, provided that the above
34cbbd215ef7 misc: add basic support for jobresults
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 * copyright notice and this permission notice appear in all copies.
34cbbd215ef7 misc: add basic support for jobresults
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 *
34cbbd215ef7 misc: add basic support for jobresults
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
34cbbd215ef7 misc: add basic support for jobresults
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
34cbbd215ef7 misc: add basic support for jobresults
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
34cbbd215ef7 misc: add basic support for jobresults
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
34cbbd215ef7 misc: add basic support for jobresults
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
34cbbd215ef7 misc: add basic support for jobresults
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
34cbbd215ef7 misc: add basic support for jobresults
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
34cbbd215ef7 misc: add basic support for jobresults
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 */
34cbbd215ef7 misc: add basic support for jobresults
David Demelier <markand@malikania.fr>
parents:
diff changeset
18
34cbbd215ef7 misc: add basic support for jobresults
David Demelier <markand@malikania.fr>
parents:
diff changeset
19 #ifndef SCI_PAGE_API_JOBRESULTS_H
34cbbd215ef7 misc: add basic support for jobresults
David Demelier <markand@malikania.fr>
parents:
diff changeset
20 #define SCI_PAGE_API_JOBRESULTS_H
34cbbd215ef7 misc: add basic support for jobresults
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-jobresults.h
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
24 * \brief Page /api/v?/jobresults 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-jobresults`.
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
24
34cbbd215ef7 misc: add basic support for jobresults
David Demelier <markand@malikania.fr>
parents:
diff changeset
29 struct kreq;
34cbbd215ef7 misc: add basic support for jobresults
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 */
24
34cbbd215ef7 misc: add basic support for jobresults
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_jobresults(struct kreq *r);
24
34cbbd215ef7 misc: add basic support for jobresults
David Demelier <markand@malikania.fr>
parents:
diff changeset
39
34cbbd215ef7 misc: add basic support for jobresults
David Demelier <markand@malikania.fr>
parents:
diff changeset
40 #endif /* !SCI_PAGE_API_JOBRESULTS_H */