Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

馃摉 JSDoc: Fix all lint errors in gulpfile.js and build-system/ #15462

Merged
merged 1 commit into from May 21, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 2 additions & 2 deletions build-system/tasks/changelog.js
Expand Up @@ -342,7 +342,7 @@ function getLastGitTag(gitMetadata) {

/**
* Runs `git log ${branch}...{tag} --pretty=oneline --first-parent`
* @param {string} tag
* @param {!GitMetadataDef} gitMetadata
* @return {!Promise<GitMetadataDef>}
*/
function getGitLog(gitMetadata) {
Expand Down Expand Up @@ -409,7 +409,7 @@ function getGithubPullRequestsMetadata(gitMetadata) {
* we will try and also fetch pulls/${id} first before fetching
* pulls/${id}/files.
*
* @param {!GitMetadataDef}
* @param {!GitMetadataDef} gitMetadata
* @return {!Promise<!GitMetadataDef>}
*/
function getGithubFilesMetadata(gitMetadata) {
Expand Down
2 changes: 0 additions & 2 deletions build-system/tasks/clean.js
Expand Up @@ -21,8 +21,6 @@ const gulp = require('gulp-help')(require('gulp'));

/**
* Clean up the build artifacts
*
* @param {function} done callback
*/
function clean() {
return del([
Expand Down
7 changes: 4 additions & 3 deletions build-system/tasks/dep-check.js
Expand Up @@ -55,7 +55,8 @@ let GlobDef;
let GlobsDef;

/**
* @constructor @final @struct
* @class @final @struct
* @param {!RuleConfigDef} config
*/
function Rule(config) {
/** @private @const {!RuleConfigDef} */
Expand Down Expand Up @@ -212,7 +213,7 @@ function getEntryModule(extensionFolder) {
* with nested dependencies. We flatten it so all we have are individual
* modules and their imports as well as making the entries unique.
*
* @param {!ModuleDef} entryModule
* @param {!Array<!ModuleDef>} entryPoints
* @return {!ModuleDef}
*/
function flattenGraph(entryPoints) {
Expand Down Expand Up @@ -287,7 +288,7 @@ function toArrayOrDefault(value, defaultValue) {
/**
* Flatten array of arrays.
*
* @type {!Array<!Array>}
* @param {!Array<!Array>} arr
*/
function flatten(arr) {
return [].concat.apply([], arr);
Expand Down
2 changes: 1 addition & 1 deletion build-system/tasks/get-zindex/index.js
Expand Up @@ -84,7 +84,6 @@ function onFileThrough(file, enc, cb) {
/**
* @param {!Object<string, !Object<string, !Array<number>} filesData
* accumulation of files and the rules and z index values.
* @param {function()} cb callback to end the stream
* @return {!Array<!Array<string>>}
*/
function createTable(filesData) {
Expand All @@ -107,6 +106,7 @@ function createTable(filesData) {


/**
* @param {string} glob
* @return {!Stream}
*/
function getZindex(glob) {
Expand Down
4 changes: 2 additions & 2 deletions build-system/tasks/prepend-global/index.js
Expand Up @@ -100,8 +100,8 @@ function writeTarget(filename, fileString, opt_dryrun) {
}

/**
* @param {string|boolean}
* @param {string}
* @param {string|boolean} value
* @param {string} defaultValue
* @return {string}
*/
function valueOrDefault(value, defaultValue) {
Expand Down
4 changes: 3 additions & 1 deletion gulpfile.js
Expand Up @@ -644,7 +644,7 @@ function buildExtension(name, version, hasCss, options, opt_extraGlobs) {

/**
* @param {string} path
* @param {string} css
* @param {string} name
* @param {string} version
* @param {!Object} options
*/
Expand Down Expand Up @@ -1295,6 +1295,7 @@ function buildWebPushPublisherFiles(options) {
/**
* Build amp-web-push publisher files HTML page.
*
* @param {string} version
* @param {!Object} options
*/
function buildWebPushPublisherFilesVersion(version, options) {
Expand Down Expand Up @@ -1369,6 +1370,7 @@ function buildLoginDone(options) {
/**
* Build "Login Done" page for the specified version.
*
* @param {string} version
* @param {!Object} options
*/
function buildLoginDoneVersion(version, options) {
Expand Down