# HG changeset patch # User David Demelier # Date 1660810374 -7200 # Node ID 3804a2ab60ec8f7d3b50b5432a6c13950ba3312e # Parent 835d52f72786c5da417ea8d192e0be8a24f1e8b6 misc: documentation improvements diff -r 835d52f72786 -r 3804a2ab60ec scid/scid.h --- 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. diff -r 835d52f72786 -r 3804a2ab60ec scid/theme.h --- 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/ */