Mercurial > sci

changeset 60:3804a2ab60ec

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
misc: documentation improvements
author David Demelier <markand@malikania.fr>
date Thu, 18 Aug 2022 10:12:54 +0200
parents 835d52f72786
children 8be8188d61a5
files scid/scid.h scid/theme.h
diffstat 2 files changed, 44 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/scid/scid.h	Thu Aug 18 10:12:46 2022 +0200
+++ b/scid/scid.h	Thu Aug 18 10:12:54 2022 +0200
@@ -73,7 +73,7 @@
  * \param components the components (as a bitmask)
  */
 void
-scid_init(enum scid_init);
+scid_init(enum scid_init components);
 
 /**
  * Cleanup scid.
--- a/scid/theme.h	Thu Aug 18 10:12:46 2022 +0200
+++ b/scid/theme.h	Thu Aug 18 10:12:54 2022 +0200
@@ -57,6 +57,7 @@
  *         {
  *           "job": job-id,
  *           "tag": "job tag / revision"
+ *           "status": true / false             // If at least one failed
  *         }
  *       ]
  *       "n-failed": number of failed jobs
@@ -96,6 +97,21 @@
  * }
  * ```
  *
+ * #### onPageWorkers
+ *
+ * Called to list all workers.
+ *
+ * ```javascript
+ * {
+ *   "workers": [
+ *     {
+ *       "name": "worker name",
+ *       "desc": "worker description",
+ *     }
+ *   ]
+ * }
+ * ```
+ *
  * #### onPageWorker
  *
  * Called to show a worker information and its recent jobs.
@@ -118,6 +134,33 @@
  * }
  * ```
  *
+ * #### onPageProjects
+ *
+ * Called to list all projects.
+ *
+ * ```javascript
+ * {
+ *   "projects": [
+ *     {
+ *       "name": "project name",
+ *       "desc": "project description",
+ *       "url" "project URL or homepage",
+ *     }
+ *   ]
+ * }
+ * ```
+ *
+ * #### onPageProject
+ *
+ * ```javascript
+ * {
+ *   "name": "project name",
+ *   "desc": "project description",
+ *   "url" "project URL or homepage",
+ *   "script": "project script code"
+ * }
+ * ```
+ *
  * [mustache]: https://mustache.github.io/
  */