From ee9f0b5d9afb1e8b8ad373ff552c53578d211da9 Mon Sep 17 00:00:00 2001 From: Pete Bacon Darwin Date: Fri, 21 Sep 2018 08:59:59 +0100 Subject: [PATCH] build(docs-infra): do not include license comment in first API doc (#26050) The default dgeni config is to concatenate leading comments in front of API items. In the case that you have an API item that starts a file with no import statements, the license comment at the top of the file was being added to the front of the API item's comment. SInce the license comment includes the `@license` tag and the API item's comment did not start with `@description` the content of the API item's comment was being put inside the `@license` tag, and no description was being extracted from the API item's comment. This commit updates to a version of dgeni-packages that has a switch to turn off this concatenation, and then also configures this switch. Closes #26045 PR Close #26050 --- aio/package.json | 2 +- aio/tools/transforms/angular-api-package/index.js | 4 +++- aio/tools/transforms/angular-base-package/index.js | 1 - aio/yarn.lock | 6 +++--- 4 files changed, 7 insertions(+), 6 deletions(-) diff --git a/aio/package.json b/aio/package.json index 9b7257ceaf..ba4920c995 100644 --- a/aio/package.json +++ b/aio/package.json @@ -114,7 +114,7 @@ "cross-spawn": "^5.1.0", "css-selector-parser": "^1.3.0", "dgeni": "^0.4.7", - "dgeni-packages": "^0.26.3", + "dgeni-packages": "^0.26.9", "entities": "^1.1.1", "eslint": "^3.19.0", "eslint-plugin-jasmine": "^2.2.0", diff --git a/aio/tools/transforms/angular-api-package/index.js b/aio/tools/transforms/angular-api-package/index.js index 9aeac8e8ce..e0465b14c1 100644 --- a/aio/tools/transforms/angular-api-package/index.js +++ b/aio/tools/transforms/angular-api-package/index.js @@ -126,10 +126,12 @@ module.exports = new Package('angular-api', [basePackage, typeScriptPackage]) }) // Configure jsdoc-style tag parsing - .config(function(parseTagsProcessor, getInjectables) { + .config(function(parseTagsProcessor, getInjectables, tsHost) { // Load up all the tag definitions in the tag-defs folder parseTagsProcessor.tagDefinitions = parseTagsProcessor.tagDefinitions.concat(getInjectables(requireFolder(__dirname, './tag-defs'))); + // We don't want license headers to be joined to the first API item's comment + tsHost.concatMultipleLeadingComments = false; }) .config(function(computeStability, splitDescription, addNotYetDocumentedProperty, API_DOC_TYPES_TO_RENDER, API_DOC_TYPES) { diff --git a/aio/tools/transforms/angular-base-package/index.js b/aio/tools/transforms/angular-base-package/index.js index 01314550a2..2c5a679cba 100644 --- a/aio/tools/transforms/angular-base-package/index.js +++ b/aio/tools/transforms/angular-base-package/index.js @@ -65,7 +65,6 @@ module.exports = new Package('angular-base', [ // Where do we write the output files? .config(function(writeFilesProcessor) { writeFilesProcessor.outputFolder = DOCS_OUTPUT_PATH; }) - // Target environments .config(function(targetEnvironments) { const ALLOWED_LANGUAGES = ['ts', 'js', 'dart']; diff --git a/aio/yarn.lock b/aio/yarn.lock index 87036bcdc2..8dc2d3bc21 100644 --- a/aio/yarn.lock +++ b/aio/yarn.lock @@ -3086,9 +3086,9 @@ devtools-timeline-model@1.1.6: chrome-devtools-frontend "1.0.401423" resolve "1.1.7" -dgeni-packages@^0.26.3: - version "0.26.3" - resolved "https://registry.yarnpkg.com/dgeni-packages/-/dgeni-packages-0.26.3.tgz#fdc1299389e7cb1b1946926fd1f5970f3a6e0838" +dgeni-packages@^0.26.9: + version "0.26.9" + resolved "https://registry.yarnpkg.com/dgeni-packages/-/dgeni-packages-0.26.9.tgz#64d0eb89046bcaec8417036c18002bdbd5062dbc" dependencies: canonical-path "0.0.2" catharsis "^0.8.1"