Mercurial > sci

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

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
misc: general documentation
author David Demelier <markand@malikania.fr>
date Thu, 04 Aug 2022 16:47:10 +0200
parents 081e1c258e64
children 71cd8447e3a4
line wrap: on
line diff
--- a/scid/page-api-jobs.h	Thu Aug 04 14:59:33 2022 +0200
+++ b/scid/page-api-jobs.h	Thu Aug 04 16:47:10 2022 +0200
@@ -1,5 +1,5 @@
 /*
- * page-api-jobs.h -- /api/v?/jobs route
+ * page-api-jobs.h -- page /api/v?/jobs route
  *
  * Copyright (c) 2021-2022 David Demelier <markand@malikania.fr>
  *
@@ -19,9 +19,22 @@
 #ifndef SCI_PAGE_API_JOBS_H
 #define SCI_PAGE_API_JOBS_H
 
+/**
+ * \file page-api-jobs.h
+ * \brief Page /api/v?/jobs route.
+ *
+ * This module logs message with tag `page-api-jobs`.
+ */
+
 struct kreq;
 
+/**
+ * Run the page.
+ *
+ * \pre r != NULL
+ * \param r the request
+ */
 void
-page_api_v1_jobs(struct kreq *);
+page_api_v1_jobs(struct kreq *r);
 
 #endif /* !SCI_PAGE_API_JOBS_H */