From ab55071568002b5008063b413e8bffacc934efb9 Mon Sep 17 00:00:00 2001 From: Jonas Jenwald Date: Sat, 26 Feb 2022 23:38:11 +0100 Subject: [PATCH] Remove the JSDocs "External: Promise"-page, since `Promise`s are now a standard feature The "External: Promise"-page in the JSDocs pre-dates the introduction of `Promise`s, as a generally available standard JS feature, by a number of years. Hence it now longer seems necessary, as far as I can tell, to include this "special" page in the documentation. Also, while unrelated to the rest of the patch, updates the `test/`-folder description in the documentation. --- docs/contents/getting_started/index.md | 2 +- gulpfile.js | 2 +- src/doc_helper.js | 25 ------------------------- 3 files changed, 2 insertions(+), 27 deletions(-) delete mode 100644 src/doc_helper.js diff --git a/docs/contents/getting_started/index.md b/docs/contents/getting_started/index.md index 1a52db38a..8f21baf25 100644 --- a/docs/contents/getting_started/index.md +++ b/docs/contents/getting_started/index.md @@ -108,7 +108,7 @@ Note that we only mention the most relevant files and folders. │   ├── interfaces.js - interface definitions for the core/display layers │   ├── pdf.*.js - wrapper files for bundling │   └── worker_loader.js - used for developer builds to load worker files -├── test/ - unit, font and reference tests +├── test/ - unit, font, reference, and integration tests ├── web/ - viewer layer ├── LICENSE ├── README.md diff --git a/gulpfile.js b/gulpfile.js index 8a4b2cd85..a148bb623 100644 --- a/gulpfile.js +++ b/gulpfile.js @@ -1373,7 +1373,7 @@ gulp.task("jsdoc", function (done) { console.log(); console.log("### Generating documentation (JSDoc)"); - const JSDOC_FILES = ["src/doc_helper.js", "src/display/api.js"]; + const JSDOC_FILES = ["src/display/api.js"]; rimraf(JSDOC_BUILD_DIR, function () { mkdirp(JSDOC_BUILD_DIR).then(function () { diff --git a/src/doc_helper.js b/src/doc_helper.js deleted file mode 100644 index fd640b786..000000000 --- a/src/doc_helper.js +++ /dev/null @@ -1,25 +0,0 @@ -/* Copyright 2012 Mozilla Foundation - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -/* - NOTE: This file is created as a helper to assist with JSDoc html files. - It is not for use in the executable code. -*/ - -/** - * Represents the eventual result of an asynchronous operation. - * @external Promise - * @see {@link http://promisesaplus.com/ Promise/A+} - */