chore: add license headers, and a CI check for their presence

This commit is contained in:
Jeff Williams 2023-01-08 16:11:38 -08:00
parent 90627ac698
commit 8c6aad8440
No known key found for this signature in database
279 changed files with 4681 additions and 209 deletions

View File

@ -1,3 +1,19 @@
/*
Copyright 2019 the JSDoc Authors.
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
https://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.
*/
module.exports = { module.exports = {
extends: ['@jsdoc', 'plugin:prettier/recommended'], extends: ['@jsdoc', 'plugin:prettier/recommended'],
root: true,
}; };

52
.license-check.json Normal file
View File

@ -0,0 +1,52 @@
{
"defaultFormat": {
"prepend": "",
"append": ""
},
"ignore": [
".parcel-cache",
"**/.*",
"!**/.*.js",
"**/*.EXAMPLE",
"**/*.json",
"**/*.md",
"**/*.txt",
"**/AUTHORS",
"**/CONTRIB*",
"**/coverage",
"**/test/fixtures",
"out",
"packages/jsdoc/templates/default/static",
"tmp"
],
"license": ".license-header.txt",
"licenseFormats": {
"css|js|mjs|scss|ts": {
"prepend": "/*",
"eachLine": {
"prepend": " "
},
"append": "*/"
},
"njk": {
"prepend": "{#-",
"eachLine": {
"prepend": " "
},
"append": "-#}"
},
"tmpl": {
"prepend": "<?js /*",
"eachLine": {
"prepend": " "
},
"append": "*/ ?>"
},
"yaml": {
"eachLine": {
"prepend": "# "
}
}
},
"regexIdentifier": "%%"
}

13
.license-header.txt Normal file
View File

@ -0,0 +1,13 @@
Copyright %%[0-9]{4}%% the JSDoc Authors.
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
https://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.

View File

@ -1,3 +1,18 @@
/*
Copyright 2021 the JSDoc Authors.
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
https://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.
*/
module.exports = { module.exports = {
...require('./packages/jsdoc-prettier-config'), ...require('./packages/jsdoc-prettier-config'),
}; };

View File

@ -84,9 +84,16 @@ export const format = task({
}, },
}); });
export const licenseHeaders = task({
name: 'license-headers',
run: async () => {
await execa(bin('license-check-and-add'), ['check', '-f', '.license-check.json']);
},
});
export const licenseCheck = task({ export const licenseCheck = task({
name: 'license-check', name: 'license-check',
dependencies: [dependencyLicenses], dependencies: [dependencyLicenses, licenseHeaders],
}); });
export const lint = task({ export const lint = task({

677
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@ -17,6 +17,7 @@
"js-green-licenses": "^3.0.1", "js-green-licenses": "^3.0.1",
"klaw-sync": "^6.0.0", "klaw-sync": "^6.0.0",
"lerna": "^6.0.3", "lerna": "^6.0.3",
"license-check-and-add": "^4.0.5",
"lodash": "^4.17.21", "lodash": "^4.17.21",
"mock-fs": "^5.2.0", "mock-fs": "^5.2.0",
"prettier": "^2.7.1", "prettier": "^2.7.1",
@ -28,8 +29,10 @@
"scripts": { "scripts": {
"coverage": "node_modules/.bin/hereby coverage", "coverage": "node_modules/.bin/hereby coverage",
"default": "node_modules/.bin/hereby", "default": "node_modules/.bin/hereby",
"dependency-licenses": "node_modules/.bin/hereby dependency-licenses",
"format": "node_modules/.bin/hereby format", "format": "node_modules/.bin/hereby format",
"license-check": "node_modules/.bin/hereby license-check", "license-check": "node_modules/.bin/hereby license-check",
"license-headers": "node_modules/.bin/hereby license-headers",
"lint": "node_modules/.bin/hereby lint", "lint": "node_modules/.bin/hereby lint",
"test": "node_modules/.bin/hereby test" "test": "node_modules/.bin/hereby test"
} }

View File

@ -1,3 +1,18 @@
/*
Copyright 2019 the JSDoc Authors.
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
https://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.
*/
const Engine = require('./lib/engine'); const Engine = require('./lib/engine');
module.exports = Engine; module.exports = Engine;

View File

@ -1,3 +1,18 @@
/*
Copyright 2019 the JSDoc Authors.
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
https://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.
*/
const _ = require('lodash'); const _ = require('lodash');
const { EventBus } = require('@jsdoc/util'); const { EventBus } = require('@jsdoc/util');
const flags = require('./flags'); const flags = require('./flags');

View File

@ -1,3 +1,18 @@
/*
Copyright 2019 the JSDoc Authors.
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
https://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.
*/
const { cast } = require('@jsdoc/util'); const { cast } = require('@jsdoc/util');
const querystring = require('querystring'); const querystring = require('querystring');

View File

@ -1,3 +1,18 @@
/*
Copyright 2019 the JSDoc Authors.
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
https://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.
*/
const flags = require('./flags'); const flags = require('./flags');
function padLeft(str, length) { function padLeft(str, length) {

View File

@ -1,3 +1,18 @@
/*
Copyright 2019 the JSDoc Authors.
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
https://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.
*/
const _ = require('lodash'); const _ = require('lodash');
const { default: ow } = require('ow'); const { default: ow } = require('ow');

View File

@ -1,3 +1,18 @@
/*
Copyright 2019 the JSDoc Authors.
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
https://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.
*/
const Engine = require('../../index'); const Engine = require('../../index');
describe('@jsdoc/cli', () => { describe('@jsdoc/cli', () => {

View File

@ -1,3 +1,18 @@
/*
Copyright 2019 the JSDoc Authors.
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
https://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.
*/
const RealEngine = require('../../../lib/engine'); const RealEngine = require('../../../lib/engine');
const flags = require('../../../lib/flags'); const flags = require('../../../lib/flags');
const { LEVELS } = require('../../../lib/logger'); const { LEVELS } = require('../../../lib/logger');

View File

@ -1,3 +1,18 @@
/*
Copyright 2019 the JSDoc Authors.
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
https://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.
*/
const flags = require('../../../lib/flags'); const flags = require('../../../lib/flags');
const { default: ow } = require('ow'); const { default: ow } = require('ow');

View File

@ -1 +1,16 @@
/*
Copyright 2019 the JSDoc Authors.
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
https://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.
*/
// `@jsdoc/cli/lib/help` is tested indirectly by the tests for `@jsdoc/cli/lib/engine`. // `@jsdoc/cli/lib/help` is tested indirectly by the tests for `@jsdoc/cli/lib/engine`.

View File

@ -1,3 +1,18 @@
/*
Copyright 2019 the JSDoc Authors.
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
https://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.
*/
const { EventBus } = require('@jsdoc/util'); const { EventBus } = require('@jsdoc/util');
const { LEVELS, Logger } = require('../../../lib/logger'); const { LEVELS, Logger } = require('../../../lib/logger');

View File

@ -1,3 +1,18 @@
/*
Copyright 2019 the JSDoc Authors.
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
https://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.
*/
/** /**
* Core functionality for JSDoc. * Core functionality for JSDoc.
* *

View File

@ -1,3 +1,18 @@
/*
Copyright 2019 the JSDoc Authors.
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
https://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.
*/
/** /**
* Manages configuration settings for JSDoc. * Manages configuration settings for JSDoc.
* *

View File

@ -1,3 +1,18 @@
/*
Copyright 2019 the JSDoc Authors.
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
https://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.
*/
const _ = require('lodash'); const _ = require('lodash');
const Bottle = require('bottlejs'); const Bottle = require('bottlejs');

View File

@ -1,3 +1,18 @@
/*
Copyright 2019 the JSDoc Authors.
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
https://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.
*/
/** /**
* Data about the environment in which JSDoc is running, including the configuration settings that * Data about the environment in which JSDoc is running, including the configuration settings that
* were used to run JSDoc. * were used to run JSDoc.

View File

@ -1,3 +1,18 @@
/*
Copyright 2019 the JSDoc Authors.
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
https://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.
*/
/** /**
* Methods for manipulating symbol names in JSDoc. * Methods for manipulating symbol names in JSDoc.
* *

View File

@ -1,3 +1,18 @@
/*
Copyright 2019 the JSDoc Authors.
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
https://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.
*/
const core = require('../../index'); const core = require('../../index');
describe('@jsdoc/core', () => { describe('@jsdoc/core', () => {

View File

@ -1,3 +1,18 @@
/*
Copyright 2019 the JSDoc Authors.
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
https://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.
*/
const mockFs = require('mock-fs'); const mockFs = require('mock-fs');
const config = require('../../../lib/config'); const config = require('../../../lib/config');

View File

@ -1,3 +1,18 @@
/*
Copyright 2019 the JSDoc Authors.
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
https://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.
*/
const Dependencies = require('../../../lib/dependencies'); const Dependencies = require('../../../lib/dependencies');
describe('@jsdoc/core/lib/dependencies', () => { describe('@jsdoc/core/lib/dependencies', () => {

View File

@ -1,3 +1,18 @@
/*
Copyright 2019 the JSDoc Authors.
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
https://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.
*/
describe('@jsdoc/core.env', () => { describe('@jsdoc/core.env', () => {
const { env } = require('../../../index'); const { env } = require('../../../index');

View File

@ -1,3 +1,18 @@
/*
Copyright 2019 the JSDoc Authors.
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
https://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.
*/
describe('@jsdoc/core.name', () => { describe('@jsdoc/core.name', () => {
const { name } = require('../../../index'); const { name } = require('../../../index');

View File

@ -1,3 +1,18 @@
/*
Copyright 2019 the JSDoc Authors.
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
https://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.
*/
module.exports = { module.exports = {
env: { env: {
es6: true, es6: true,

View File

@ -1,3 +1,18 @@
/*
Copyright 2020 the JSDoc Authors.
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
https://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.
*/
const { AstBuilder } = require('./lib/ast-builder'); const { AstBuilder } = require('./lib/ast-builder');
const astNode = require('./lib/ast-node'); const astNode = require('./lib/ast-node');
const { Syntax } = require('./lib/syntax'); const { Syntax } = require('./lib/syntax');

View File

@ -1,3 +1,18 @@
/*
Copyright 2020 the JSDoc Authors.
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
https://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.
*/
const _ = require('lodash'); const _ = require('lodash');
const babelParser = require('@babel/parser'); const babelParser = require('@babel/parser');
const { log } = require('@jsdoc/util'); const { log } = require('@jsdoc/util');

View File

@ -1,3 +1,18 @@
/*
Copyright 2020 the JSDoc Authors.
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
https://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.
*/
// TODO: docs // TODO: docs
/** @module @jsdoc/parse.astNode */ /** @module @jsdoc/parse.astNode */
const _ = require('lodash'); const _ = require('lodash');

View File

@ -1,3 +1,18 @@
/*
Copyright 2020 the JSDoc Authors.
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
https://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.
*/
// TODO: docs // TODO: docs
exports.Syntax = { exports.Syntax = {
ArrayExpression: 'ArrayExpression', ArrayExpression: 'ArrayExpression',

View File

@ -1,3 +1,18 @@
/*
Copyright 2020 the JSDoc Authors.
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
https://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.
*/
const parse = require('../../index'); const parse = require('../../index');
describe('@jsdoc/parse', () => { describe('@jsdoc/parse', () => {

View File

@ -1,3 +1,18 @@
/*
Copyright 2020 the JSDoc Authors.
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
https://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.
*/
/* global jsdoc */ /* global jsdoc */
describe('@jsdoc/parse/lib/ast-builder', () => { describe('@jsdoc/parse/lib/ast-builder', () => {
const astBuilder = require('../../../lib/ast-builder'); const astBuilder = require('../../../lib/ast-builder');

View File

@ -1,3 +1,18 @@
/*
Copyright 2020 the JSDoc Authors.
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
https://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.
*/
describe('@jsdoc/parse/lib/ast-node', () => { describe('@jsdoc/parse/lib/ast-node', () => {
const astNode = require('../../../lib/ast-node'); const astNode = require('../../../lib/ast-node');
const babelParser = require('@babel/parser'); const babelParser = require('@babel/parser');

View File

@ -1,3 +1,18 @@
/*
Copyright 2020 the JSDoc Authors.
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
https://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.
*/
describe('@jsdoc/parse.Syntax', () => { describe('@jsdoc/parse.Syntax', () => {
const { Syntax } = require('../../../index'); const { Syntax } = require('../../../index');

View File

@ -1,3 +1,18 @@
/*
Copyright 2021 the JSDoc Authors.
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
https://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.
*/
// https://prettier.io/docs/en/options.html // https://prettier.io/docs/en/options.html
module.exports = { module.exports = {
printWidth: 100, printWidth: 100,

View File

@ -1,3 +1,18 @@
/*
Copyright 2022 the JSDoc Authors.
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
https://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.
*/
const Salty = require('./lib/salty'); const Salty = require('./lib/salty');
module.exports = { module.exports = {

View File

@ -1,3 +1,18 @@
/*
Copyright 2022 the JSDoc Authors.
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
https://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.
*/
const _ = require('lodash'); const _ = require('lodash');
// Install shim for Object.hasOwn() if necessary. // Install shim for Object.hasOwn() if necessary.

View File

@ -1,3 +1,18 @@
/*
Copyright 2022 the JSDoc Authors.
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
https://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.
*/
const salty = require('../../index'); const salty = require('../../index');
describe('@jsdoc/salty', () => { describe('@jsdoc/salty', () => {

View File

@ -1,3 +1,18 @@
/*
Copyright 2022 the JSDoc Authors.
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
https://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.
*/
describe('@jsdoc/salty/lib/salty', () => { describe('@jsdoc/salty/lib/salty', () => {
const _ = require('lodash'); const _ = require('lodash');
const Salty = require('../../../lib/salty'); const Salty = require('../../../lib/salty');

View File

@ -1,3 +1,18 @@
/*
Copyright 2020 the JSDoc Authors.
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
https://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.
*/
const inline = require('./lib/inline'); const inline = require('./lib/inline');
const type = require('./lib/type'); const type = require('./lib/type');

View File

@ -1,3 +1,18 @@
/*
Copyright 2020 the JSDoc Authors.
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
https://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.
*/
/** /**
* @module @jsdoc/tag/lib/inline * @module @jsdoc/tag/lib/inline
* @alias @jsdoc/tag.inline * @alias @jsdoc/tag.inline

View File

@ -1,3 +1,18 @@
/*
Copyright 2020 the JSDoc Authors.
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
https://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.
*/
/** /**
* @module @jsdoc/tag/lib/type * @module @jsdoc/tag/lib/type
* @alias @jsdoc/tag.type * @alias @jsdoc/tag.type

View File

@ -1,3 +1,18 @@
/*
Copyright 2020 the JSDoc Authors.
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
https://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.
*/
const tag = require('../../index'); const tag = require('../../index');
describe('@jsdoc/tag', () => { describe('@jsdoc/tag', () => {

View File

@ -1,3 +1,18 @@
/*
Copyright 2020 the JSDoc Authors.
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
https://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.
*/
describe('@jsdoc/tag/lib/inline', () => { describe('@jsdoc/tag/lib/inline', () => {
const inline = require('../../../lib/inline'); const inline = require('../../../lib/inline');

View File

@ -1,3 +1,18 @@
/*
Copyright 2020 the JSDoc Authors.
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
https://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.
*/
function buildText(type, name, desc) { function buildText(type, name, desc) {
let text = ''; let text = '';

View File

@ -1,3 +1,18 @@
/*
Copyright 2019 the JSDoc Authors.
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
https://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.
*/
const Task = require('./lib/task'); const Task = require('./lib/task');
const TaskRunner = require('./lib/task-runner'); const TaskRunner = require('./lib/task-runner');

View File

@ -1,3 +1,18 @@
/*
Copyright 2019 the JSDoc Authors.
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
https://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.
*/
const _ = require('lodash'); const _ = require('lodash');
const { DepGraph } = require('dependency-graph'); const { DepGraph } = require('dependency-graph');
const Emittery = require('emittery'); const Emittery = require('emittery');

View File

@ -1,3 +1,18 @@
/*
Copyright 2019 the JSDoc Authors.
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
https://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.
*/
const Emittery = require('emittery'); const Emittery = require('emittery');
const { default: ow } = require('ow'); const { default: ow } = require('ow');

View File

@ -1,3 +1,18 @@
/*
Copyright 2019 the JSDoc Authors.
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
https://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.
*/
const { default: ow } = require('ow'); const { default: ow } = require('ow');
const Task = require('./task'); const Task = require('./task');

View File

@ -1,3 +1,18 @@
/*
Copyright 2019 the JSDoc Authors.
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
https://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.
*/
const taskRunner = require('../../index'); const taskRunner = require('../../index');
describe('@jsdoc/task-runner', () => { describe('@jsdoc/task-runner', () => {

View File

@ -1,3 +1,18 @@
/*
Copyright 2019 the JSDoc Authors.
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
https://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.
*/
const Emittery = require('emittery'); const Emittery = require('emittery');
const Task = require('../../../lib/task'); const Task = require('../../../lib/task');
const TaskRunner = require('../../../lib/task-runner'); const TaskRunner = require('../../../lib/task-runner');

View File

@ -1,3 +1,18 @@
/*
Copyright 2019 the JSDoc Authors.
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
https://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.
*/
const Emittery = require('emittery'); const Emittery = require('emittery');
const Task = require('../../../lib/task'); const Task = require('../../../lib/task');

View File

@ -1,3 +1,18 @@
/*
Copyright 2019 the JSDoc Authors.
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
https://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.
*/
const _ = require('lodash'); const _ = require('lodash');
const { addMatchers } = require('add-matchers'); const { addMatchers } = require('add-matchers');
const { format } = require('prettier'); const { format } = require('prettier');

View File

@ -1,3 +1,18 @@
/*
Copyright 2019 the JSDoc Authors.
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
https://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.
*/
/** /**
* Utility modules for JSDoc. * Utility modules for JSDoc.
* *

View File

@ -1,3 +1,18 @@
/*
Copyright 2019 the JSDoc Authors.
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
https://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.
*/
const _ = require('lodash'); const _ = require('lodash');
const EventEmitter = require('events').EventEmitter; const EventEmitter = require('events').EventEmitter;
const { default: ow } = require('ow'); const { default: ow } = require('ow');

View File

@ -1,3 +1,18 @@
/*
Copyright 2019 the JSDoc Authors.
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
https://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.
*/
/** /**
* Module to convert values between various JavaScript types. * Module to convert values between various JavaScript types.
* *

View File

@ -1,3 +1,18 @@
/*
Copyright 2019 the JSDoc Authors.
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
https://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.
*/
/** /**
* @alias @jsdoc/util.fs * @alias @jsdoc/util.fs
*/ */

View File

@ -1,3 +1,18 @@
/*
Copyright 2019 the JSDoc Authors.
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
https://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.
*/
const EventBus = require('./bus'); const EventBus = require('./bus');
const bus = new EventBus('jsdoc'); const bus = new EventBus('jsdoc');

View File

@ -1,3 +1,18 @@
/*
Copyright 2019 the JSDoc Authors.
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
https://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.
*/
const util = require('../../index'); const util = require('../../index');
describe('@jsdoc/util', () => { describe('@jsdoc/util', () => {

View File

@ -1,3 +1,18 @@
/*
Copyright 2019 the JSDoc Authors.
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
https://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.
*/
describe('@jsdoc/util/lib/bus', () => { describe('@jsdoc/util/lib/bus', () => {
const EventBus = require('../../../lib/bus'); const EventBus = require('../../../lib/bus');
const EventEmitter = require('events').EventEmitter; const EventEmitter = require('events').EventEmitter;

View File

@ -1,3 +1,18 @@
/*
Copyright 2019 the JSDoc Authors.
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
https://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.
*/
describe('@jsdoc/util/lib/cast', () => { describe('@jsdoc/util/lib/cast', () => {
const cast = require('../../../lib/cast'); const cast = require('../../../lib/cast');

View File

@ -1,3 +1,18 @@
/*
Copyright 2019 the JSDoc Authors.
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
https://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.
*/
describe('@jsdoc/util/lib/fs', () => { describe('@jsdoc/util/lib/fs', () => {
const mockFs = require('mock-fs'); const mockFs = require('mock-fs');
const fsUtil = require('../../../lib/fs'); const fsUtil = require('../../../lib/fs');

View File

@ -1,3 +1,18 @@
/*
Copyright 2019 the JSDoc Authors.
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
https://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.
*/
describe('@jsdoc/util/lib/log', () => { describe('@jsdoc/util/lib/log', () => {
const EventBus = require('../../../lib/bus'); const EventBus = require('../../../lib/bus');
const log = require('../../../lib/log'); const log = require('../../../lib/log');

View File

@ -1,3 +1,18 @@
/*
Copyright 2011 the JSDoc Authors.
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
https://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.
*/
/* eslint-disable indent, no-process-exit */ /* eslint-disable indent, no-process-exit */
const _ = require('lodash'); const _ = require('lodash');
const { config, Dependencies } = require('@jsdoc/core'); const { config, Dependencies } = require('@jsdoc/core');

View File

@ -1,4 +1,19 @@
#!/usr/bin/env node #!/usr/bin/env node
/*
Copyright 2011 the JSDoc Authors.
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
https://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.
*/
const { env } = require('@jsdoc/core'); const { env } = require('@jsdoc/core');

View File

@ -1,3 +1,18 @@
/*
Copyright 2011 the JSDoc Authors.
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
https://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.
*/
/** /**
* Provides methods for augmenting the parse results based on their content. * Provides methods for augmenting the parse results based on their content.
* @module jsdoc/augment * @module jsdoc/augment

View File

@ -1,3 +1,18 @@
/*
Copyright 2011 the JSDoc Authors.
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
https://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.
*/
/** /**
* A collection of functions relating to resolving @borrows tags in JSDoc symbols. * A collection of functions relating to resolving @borrows tags in JSDoc symbols.
* @module jsdoc/borrow * @module jsdoc/borrow

View File

@ -1,3 +1,18 @@
/*
Copyright 2010 the JSDoc Authors.
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
https://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.
*/
/** /**
* @module jsdoc/doclet * @module jsdoc/doclet
*/ */

View File

@ -1,3 +1,18 @@
/*
Copyright 2011 the JSDoc Authors.
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
https://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.
*/
const { log } = require('@jsdoc/util'); const { log } = require('@jsdoc/util');
const stripBom = require('strip-bom'); const stripBom = require('strip-bom');

View File

@ -1,3 +1,18 @@
/*
Copyright 2012 the JSDoc Authors.
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
https://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.
*/
/** /**
* Utility functions to support the JSDoc plugin framework. * Utility functions to support the JSDoc plugin framework.
* @module jsdoc/plugins * @module jsdoc/plugins

View File

@ -1,3 +1,18 @@
/*
Copyright 2010 the JSDoc Authors.
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
https://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.
*/
/** /**
* Schema for validating JSDoc doclets. * Schema for validating JSDoc doclets.
* @module jsdoc/schema * @module jsdoc/schema

View File

@ -1,3 +1,18 @@
/*
Copyright 2012 the JSDoc Authors.
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
https://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.
*/
/** /**
* @module jsdoc/src/filter * @module jsdoc/src/filter
*/ */

View File

@ -1,3 +1,18 @@
/*
Copyright 2010 the JSDoc Authors.
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
https://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.
*/
/** /**
* @module jsdoc/src/handlers * @module jsdoc/src/handlers
*/ */

View File

@ -1,3 +1,18 @@
/*
Copyright 2010 the JSDoc Authors.
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
https://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.
*/
/** /**
* @module jsdoc/src/parser * @module jsdoc/src/parser
*/ */

View File

@ -1,3 +1,18 @@
/*
Copyright 2010 the JSDoc Authors.
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
https://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.
*/
/** /**
* @module jsdoc/src/scanner * @module jsdoc/src/scanner
*/ */

View File

@ -1,3 +1,18 @@
/*
Copyright 2012 the JSDoc Authors.
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
https://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.
*/
/** /**
* @module jsdoc/src/visitor * @module jsdoc/src/visitor
*/ */

View File

@ -1,3 +1,18 @@
/*
Copyright 2013 the JSDoc Authors.
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
https://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.
*/
/** /**
* Traversal utilities for ASTs that are compatible with the ESTree API. * Traversal utilities for ASTs that are compatible with the ESTree API.
* *

View File

@ -1,3 +1,18 @@
/*
Copyright 2010 the JSDoc Authors.
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
https://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.
*/
/** /**
* Functionality related to JSDoc tags. * Functionality related to JSDoc tags.
* @module jsdoc/tag * @module jsdoc/tag

View File

@ -1,3 +1,18 @@
/*
Copyright 2010 the JSDoc Authors.
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
https://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.
*/
/** @module jsdoc/tag/dictionary */ /** @module jsdoc/tag/dictionary */
const definitions = require('jsdoc/tag/dictionary/definitions'); const definitions = require('jsdoc/tag/dictionary/definitions');
const { log } = require('@jsdoc/util'); const { log } = require('@jsdoc/util');

View File

@ -1,3 +1,18 @@
/*
Copyright 2010 the JSDoc Authors.
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
https://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.
*/
/** /**
* Define tags that are known in JSDoc. * Define tags that are known in JSDoc.
* @module jsdoc/tag/dictionary/definitions * @module jsdoc/tag/dictionary/definitions

View File

@ -1,3 +1,18 @@
/*
Copyright 2010 the JSDoc Authors.
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
https://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.
*/
/** /**
* @module jsdoc/tag/validator * @module jsdoc/tag/validator
* @requires jsdoc/tag/dictionary * @requires jsdoc/tag/dictionary

View File

@ -1,3 +1,18 @@
/*
Copyright 2012 the JSDoc Authors.
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
https://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.
*/
/** /**
* Wrapper for Lodash's template utility to allow loading templates from files. * Wrapper for Lodash's template utility to allow loading templates from files.
* @module jsdoc/template * @module jsdoc/template

View File

@ -1,3 +1,18 @@
/*
Copyright 2011 the JSDoc Authors.
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
https://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.
*/
/** /**
* @module jsdoc/util/templateHelper * @module jsdoc/util/templateHelper
*/ */

View File

@ -1,3 +1,18 @@
/*
Copyright 2011 the JSDoc Authors.
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
https://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.
*/
/* eslint-disable spaced-comment */ /* eslint-disable spaced-comment */
/** /**
* Demonstrate how to modify the source code before the parser sees it. * Demonstrate how to modify the source code before the parser sees it.

View File

@ -1,3 +1,18 @@
/*
Copyright 2013 the JSDoc Authors.
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
https://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.
*/
/** /**
* Remove everything in a file except JSDoc-style comments. By enabling this plugin, you can * Remove everything in a file except JSDoc-style comments. By enabling this plugin, you can
* document source files that are not valid JavaScript (including source files for other languages). * document source files that are not valid JavaScript (including source files for other languages).

View File

@ -1,3 +1,18 @@
/*
Copyright 2011 the JSDoc Authors.
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
https://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.
*/
/** /**
* Escape HTML tags in descriptions. * Escape HTML tags in descriptions.
* *

View File

@ -1,3 +1,18 @@
/*
Copyright 2012 the JSDoc Authors.
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
https://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.
*/
/** /**
* Dump information about parser events to the console. * Dump information about parser events to the console.
* *

View File

@ -1,3 +1,18 @@
/*
Copyright 2013 the JSDoc Authors.
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
https://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.
*/
/** /**
* The Overload Helper plugin automatically adds a signature-like string to the longnames of * The Overload Helper plugin automatically adds a signature-like string to the longnames of
* overloaded functions and methods. In JSDoc, this string is known as a _variation_. (The longnames * overloaded functions and methods. In JSDoc, this string is known as a _variation_. (The longnames

View File

@ -1,3 +1,18 @@
/*
Copyright 2012 the JSDoc Authors.
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
https://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.
*/
/** /**
* Adds support for reusable partial jsdoc files. * Adds support for reusable partial jsdoc files.
* *

View File

@ -1,3 +1,18 @@
/*
Copyright 2012 the JSDoc Authors.
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
https://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.
*/
/** /**
* Strips the rails template tags from a js.erb file * Strips the rails template tags from a js.erb file
* *

View File

@ -1,3 +1,18 @@
/*
Copyright 2011 the JSDoc Authors.
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
https://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.
*/
/** /**
* This is just an example. * This is just an example.
* *

View File

@ -1,3 +1,18 @@
/*
Copyright 2011 the JSDoc Authors.
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
https://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.
*/
/** /**
* @module plugins/sourcetag * @module plugins/sourcetag
*/ */

View File

@ -1,3 +1,18 @@
/*
Copyright 2014 the JSDoc Authors.
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
https://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.
*/
/** /**
* This plugin creates a summary tag, if missing, from the first sentence in the description. * This plugin creates a summary tag, if missing, from the first sentence in the description.
* *

View File

@ -1,3 +1,18 @@
/*
Copyright 2012 the JSDoc Authors.
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
https://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.
*/
/* global jsdoc */ /* global jsdoc */
describe('commentConvert plugin', () => { describe('commentConvert plugin', () => {

View File

@ -1,3 +1,18 @@
/*
Copyright 2012 the JSDoc Authors.
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
https://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.
*/
/* global jsdoc */ /* global jsdoc */
describe('escapeHtml plugin', () => { describe('escapeHtml plugin', () => {
const path = require('path'); const path = require('path');

View File

@ -1,3 +1,18 @@
/*
Copyright 2013 the JSDoc Authors.
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
https://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.
*/
/* global jsdoc */ /* global jsdoc */
describe('plugins/overloadHelper', () => { describe('plugins/overloadHelper', () => {
const path = require('path'); const path = require('path');

View File

@ -1,3 +1,18 @@
/*
Copyright 2012 the JSDoc Authors.
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
https://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.
*/
/* global jsdoc */ /* global jsdoc */
describe('railsTemplate plugin', () => { describe('railsTemplate plugin', () => {
const path = require('path'); const path = require('path');

View File

@ -1,3 +1,18 @@
/*
Copyright 2012 the JSDoc Authors.
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
https://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.
*/
/* global jsdoc */ /* global jsdoc */
describe('shout plugin', () => { describe('shout plugin', () => {
const path = require('path'); const path = require('path');

Some files were not shown because too many files have changed in this diff Show More