summaryrefslogtreecommitdiffhomepage
path: root/lib
diff options
context:
space:
mode:
authorJo-Philipp Wich <jo@mein.io>2023-07-12 16:45:12 +0200
committerJo-Philipp Wich <jo@mein.io>2023-07-13 10:41:24 +0200
commitf1190ef2f2719582efcad4109f1215b02baebfdf (patch)
treed9a2644de3ba6c1032a4a3b5643fa78b26a84aa8 /lib
parentcba0c3cf5312cdaed0538bb3dbf87b31b3e89916 (diff)
docs: various improvements
- Switch JSDoc theme to "clean-jsdoc-theme" - Add some custom CSS and JS tweaks to the theme - Use a condensed README.md for the toplevel directory - Include a longer README.md in the documentation portal - Tweak JSDoc annotations for better output results - Register `ucode.mein.io` CNAME Signed-off-by: Jo-Philipp Wich <jo@mein.io>
Diffstat (limited to 'lib')
-rw-r--r--lib/fs.c28
-rw-r--r--lib/math.c4
2 files changed, 26 insertions, 6 deletions
diff --git a/lib/fs.c b/lib/fs.c
index 015228a..45cef36 100644
--- a/lib/fs.c
+++ b/lib/fs.c
@@ -15,7 +15,9 @@
*/
/**
- * This module provides functions for interacting with the file system.
+ * # Filesystem Access
+ *
+ * The `fs` module provides functions for interacting with the file system.
*
* Functions can be individually imported and directly accessed using the
* {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/import#named_import named import}
@@ -256,7 +258,11 @@ uc_fs_fileno_common(uc_vm_t *vm, size_t nargs, const char *type)
/**
* Represents a handle for interacting with a program launched by `popen()`.
*
- * @namespace module:fs.proc
+ * @class module:fs.proc
+ * @hideconstructor
+ *
+ * @see {@link module:fs#popen|popen()}
+ *
* @example
*
* const handle = popen(…);
@@ -522,9 +528,17 @@ uc_fs_popen(uc_vm_t *vm, size_t nargs)
/**
- * Represents a handle for interacting with a file opened by `open()`.
+ * Represents a handle for interacting with a file opened by one of the file
+ * open functions.
+ *
+ * @class module:fs.file
+ * @hideconstructor
+ *
+ * @see {@link module:fs#open|open()}
+ * @see {@link module:fs#fdopen|fdopen()}
+ * @see {@link module:fs#mkstemp|mkstemp()}
+ * @see {@link module:fs#pipe|pipe()}
*
- * @namespace module:fs.file
* @example
*
* const handle = open(…);
@@ -1044,7 +1058,11 @@ uc_fs_fdopen(uc_vm_t *vm, size_t nargs)
/**
* Represents a handle for interacting with a directory opened by `opendir()`.
*
- * @namespace module:fs.dir
+ * @class module:fs.dir
+ * @hideconstructor
+ *
+ * @see {@link module:fs#opendir|opendir()}
+ *
* @example
*
* const handle = opendir(…);
diff --git a/lib/math.c b/lib/math.c
index 7ace577..91c5c30 100644
--- a/lib/math.c
+++ b/lib/math.c
@@ -15,7 +15,9 @@
*/
/**
- * This module bundles various mathematical functions.
+ * # Mathematical Functions
+ *
+ * The `math` module bundles various mathematical and trigonometrical functions.
*
* Functions can be individually imported and directly accessed using the
* {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/import#named_import named import}