summaryrefslogtreecommitdiffhomepage
path: root/jsdoc/conf.json
diff options
context:
space:
mode:
authorJo-Philipp Wich <jo@mein.io>2023-05-31 13:28:14 +0200
committerJo-Philipp Wich <jo@mein.io>2023-07-12 10:45:21 +0200
commit70f93488b93e8baa5b090d427019e70da933eb33 (patch)
tree7c4b10cd827fdb51e457c3aaba3b0ede0c62d42b /jsdoc/conf.json
parente06f656f5043d5b86f6ccfb7f9b8447800623659 (diff)
docs: add initial JSDoc infrastructure
Introduce the infrastructure for building ucode module documentation using JSDoc annotations. To build the documentation, run `npm install` followed by `npm run doc`. Signed-off-by: Jo-Philipp Wich <jo@mein.io>
Diffstat (limited to 'jsdoc/conf.json')
-rw-r--r--jsdoc/conf.json29
1 files changed, 29 insertions, 0 deletions
diff --git a/jsdoc/conf.json b/jsdoc/conf.json
new file mode 100644
index 0000000..50be361
--- /dev/null
+++ b/jsdoc/conf.json
@@ -0,0 +1,29 @@
+{
+ "tags": {
+ "allowUnknownTags": true,
+ "dictionaries": ["jsdoc","closure"]
+ },
+ "source": {
+ "include": ["."],
+ "exclude": ["CMakeFiles"],
+ "includePattern": ".+\\.c$"
+ },
+ "plugins": [
+ "plugins/markdown",
+ "jsdoc/c-transpiler"
+
+ ],
+ "templates": {
+ "referenceTitle": "OpenWrt ucode library reference",
+ "disableSort": false,
+ "collapse": true,
+ "resources_": {
+ "OpenWrt": "https://openwrt.org/"
+ }
+ },
+ "opts": {
+ "destination": "docs",
+ "recurse": true,
+ "readme": "docs/README.md"
+ }
+}