From 968e6437ad7417dbe5d993146587c6a490c12243 Mon Sep 17 00:00:00 2001 From: EliasSchriefer Date: Tue, 17 Aug 2021 13:38:59 +0200 Subject: [PATCH] Setup coding environment for VSCode and jsdoc --- .gitignore | 2 ++ .vscode/tasks.json | 23 +++++++++++++++++++++++ jsdoc.json | 3 +++ 3 files changed, 28 insertions(+) create mode 100644 .gitignore create mode 100644 .vscode/tasks.json create mode 100644 jsdoc.json diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..308a82a --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +# jsdoc-generated documentation +doc \ No newline at end of file diff --git a/.vscode/tasks.json b/.vscode/tasks.json new file mode 100644 index 0000000..22d91e8 --- /dev/null +++ b/.vscode/tasks.json @@ -0,0 +1,23 @@ +{ + "version": "2.0.0", + "tasks": [ + { + "label": "jsdoc", + "type": "process", + "command": "jsdoc", + "args": ["src/LightDMMock.js", "-c", "jsdoc.json", "-d", "doc"], + "detail": "Generate documentation", + "presentation": { + "echo": false, + "reveal": "silent", + "showReuseMessage": false, + "panel": "dedicated", + "close": true, + }, + "group": { + "kind": "build", + "isDefault": true, + }, + } + ] +} \ No newline at end of file diff --git a/jsdoc.json b/jsdoc.json new file mode 100644 index 0000000..ee2738f --- /dev/null +++ b/jsdoc.json @@ -0,0 +1,3 @@ +{ + "plugins": ["plugins/markdown"] +} \ No newline at end of file