From 7476136a81dc2f92157fab00074c248488210d7e Mon Sep 17 00:00:00 2001 From: Chi Huu Huynh <73843190+Chi-EEE@users.noreply.github.com> Date: Sat, 7 Oct 2023 16:18:20 +0100 Subject: [PATCH] Add jsdoc config file --- .gitignore | 2 ++ backend/Doxyfile | 2 +- frontend/jsdoc.config.json | 25 +++++++++++++++++++++++++ 3 files changed, 28 insertions(+), 1 deletion(-) create mode 100644 frontend/jsdoc.config.json diff --git a/.gitignore b/.gitignore index de40d0f4..d0021b1e 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,5 @@ +docs/* + # Xmake cache .xmake/ build/ diff --git a/backend/Doxyfile b/backend/Doxyfile index fb77791c..3e4ac903 100644 --- a/backend/Doxyfile +++ b/backend/Doxyfile @@ -68,7 +68,7 @@ PROJECT_LOGO = # entered, it will be relative to the location where doxygen was started. If # left blank the current directory will be used. -OUTPUT_DIRECTORY = ".." +OUTPUT_DIRECTORY = "docs/doxygen" # If the CREATE_SUBDIRS tag is set to YES then doxygen will create up to 4096 # sub-directories (in 2 levels) under the output directory of each output format diff --git a/frontend/jsdoc.config.json b/frontend/jsdoc.config.json new file mode 100644 index 00000000..fda8c6a2 --- /dev/null +++ b/frontend/jsdoc.config.json @@ -0,0 +1,25 @@ +{ + "plugins": [ + "plugins/markdown" + ], + "recurseDepth": 10, + "source": { + "includePattern": ".+\\.js(doc|x)?$", + "excludePattern": "(^|\\/|\\\\)_" + }, + "sourceType": "module", + "tags": { + "include": [ "src/lib" ], + "allowUnknownTags": true, + "dictionaries": ["jsdoc","closure"] + }, + "templates": { + "cleverLinks": false, + "monospaceLinks": false + }, + "opts": { + "encoding": "utf8", + "destination": "docs/jsdoc", + "recurse": true + } +} \ No newline at end of file