From 0e28238027f4fd39119b772e402f55b0c1133742 Mon Sep 17 00:00:00 2001 From: Stephen Niedzielski Date: Thu, 19 Jul 2018 08:59:29 -0500 Subject: [PATCH] Hygiene: make JSDoc configs consistent Make the Popups, MobileFrontend, and MinervaNeue JSDocs consistent. For MinervaNeue: - Replace "packageX" option which was unfound in the JSDoc repo with "package". - Remove redundant default configurations. - Replace tabs with spaces since that's the standard in this repo. http://usejsdoc.org/about-configuring-jsdoc.html http://usejsdoc.org/about-commandline.html http://usejsdoc.org/about-configuring-default-template.html Bug: T188261 Change-Id: Ic767e78ceee35400bdd9bb6f51c865e475f8f337 --- .gitignore | 5 ++--- jsdoc.json | 36 ++++++++++++++++-------------------- 2 files changed, 18 insertions(+), 23 deletions(-) diff --git a/.gitignore b/.gitignore index 7951712..184e3e9 100644 --- a/.gitignore +++ b/.gitignore @@ -1,6 +1,5 @@ -# JSDuck output -/docs/ - +/docs/js/ +/docs/php/ /node_modules/ /vendor /composer.lock diff --git a/jsdoc.json b/jsdoc.json index b9cf03f..e3f183f 100644 --- a/jsdoc.json +++ b/jsdoc.json @@ -1,22 +1,18 @@ { - "opts": { - "encoding": "utf8", - "destination": "docs", - "packageX": "package.json", - "readme": "README.md", - "recurse": true - }, - "plugins": [], - "recurseDepth": 10, - "source": { - "include": [ "resources" ], - "includePattern": ".+\\.js$" - }, - "tags": {}, - "templates": { - "cleverLinks": true, - "default": { - "useLongnameInNav": true - } - } + "opts": { + "destination": "docs/js", + "package": "package.json", + "pedantic": true, + "readme": "README.md", + "recurse": true + }, + "source": { + "include": [ "resources" ] + }, + "templates": { + "cleverLinks": true, + "default": { + "useLongnameInNav": true + } + } }