- Use typedoc to generate API document instead of jsdoc.

- Add @typedef JSDoc annotaion. Fix mozilla#16705
tamuratak · Aug 6, 2023 · 33e1777 · 33e1777
1 parent a2728d0
commit 33e1777
Show file tree

Hide file tree

Showing 4 changed files with 99 additions and 201 deletions.
diff --git a/gulpfile.mjs b/gulpfile.mjs
@@ -1516,9 +1516,13 @@ gulp.task("jsdoc", function (done) {
 
   rimraf(JSDOC_BUILD_DIR, function () {
     mkdirp(JSDOC_BUILD_DIR).then(function () {
+      const args = [
+        "excludeProtected",
+        "excludePrivate",
+        `out ${JSDOC_BUILD_DIR}`
+      ].join(" --");
       const command =
-        '"node_modules/.bin/jsdoc" -d ' +
-        JSDOC_BUILD_DIR +
+        `"node_modules/.bin/typedoc" --${args}` +
         " " +
         JSDOC_FILES.join(" ");
       exec(command, done);