mirror of
https://github.com/angular/angular.git
synced 2026-09-14 13:54:52 +08:00
docs: ensure jsdocs are properly set (#9390)
This commit is contained in:
committed by
Joey Perrott
parent
75eccb53f7
commit
151e58142c
@@ -108,7 +108,7 @@ export function hasDecorator(doc: {decorators?: {name: string}[]}, decoratorName
|
||||
/**
|
||||
* Decorates public exposed docs. Creates a property on the doc that indicates whether
|
||||
* the item is deprecated or not.
|
||||
**/
|
||||
*/
|
||||
export function decorateDeprecatedDoc(doc: {isDeprecated: boolean}) {
|
||||
doc.isDeprecated = isDeprecatedDoc(doc);
|
||||
}
|
||||
|
||||
@@ -17,5 +17,5 @@ task('ci:payload', ['payload']);
|
||||
/** Task that uploads the coverage results to a firebase database. */
|
||||
task('ci:coverage', ['coverage:upload']);
|
||||
|
||||
/** Task that verifies if all Material components are working with platform-server.*/
|
||||
/** Task that verifies if all Material components are working with platform-server. */
|
||||
task('ci:prerender', ['prerender']);
|
||||
|
||||
@@ -5,7 +5,7 @@ const cloudStorage = require('@google-cloud/storage');
|
||||
// Firebase configuration for the Screenshot project. Use the config from the screenshot functions.
|
||||
const screenshotFirebaseConfig = require('../../screenshot-test/functions/config.json');
|
||||
|
||||
/** Database URL of the dashboard firebase project.*/
|
||||
/** Database URL of the dashboard firebase project. */
|
||||
const dashboardDatabaseUrl = 'https://material2-board.firebaseio.com';
|
||||
|
||||
/** Opens a connection to the Firebase dashboard app using a service account. */
|
||||
|
||||
@@ -4,7 +4,7 @@ import * as gulp from 'gulp';
|
||||
import * as path from 'path';
|
||||
import {buildConfig} from 'material2-build-tools';
|
||||
|
||||
/* Those imports lack typings. */
|
||||
// Those imports lack typings.
|
||||
const gulpClean = require('gulp-clean');
|
||||
const gulpConnect = require('gulp-connect');
|
||||
|
||||
|
||||
@@ -100,7 +100,7 @@ export class PackageBundler {
|
||||
await remapSourcemap(config.umdMinDest);
|
||||
}
|
||||
|
||||
/** Creates a rollup bundle of a specified JavaScript file.*/
|
||||
/** Creates a rollup bundle of a specified JavaScript file. */
|
||||
private async createRollupBundle(config: RollupBundleConfig) {
|
||||
const bundleOptions = {
|
||||
context: 'this',
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
/* tslint:disable:no-eval */
|
||||
// tslint:disable:no-eval
|
||||
|
||||
import {dirname, join} from 'path';
|
||||
import {readFileSync, writeFileSync} from 'fs';
|
||||
|
||||
@@ -4,7 +4,7 @@ const sorcery = require('sorcery');
|
||||
/**
|
||||
* Finds the original sourcemap of the file and maps it to the current file.
|
||||
* This is useful when multiple transformation happen (e.g TSC -> Rollup -> Uglify)
|
||||
**/
|
||||
*/
|
||||
export async function remapSourcemap(sourceFile: string) {
|
||||
// Once sorcery loaded the chain of sourcemaps, the new sourcemap will be written asynchronously.
|
||||
return (await sorcery.load(sourceFile)).write();
|
||||
|
||||
@@ -41,7 +41,8 @@ export class FirebaseService {
|
||||
return firebase.storage().ref('goldens').child(filename).getDownloadURL();
|
||||
}
|
||||
|
||||
/** Set pull request number. All test information and pull request information will be retrived
|
||||
/**
|
||||
* Set pull request number. All test information and pull request information will be retrived
|
||||
* from database
|
||||
*/
|
||||
set prNumber(prNumber: string) {
|
||||
|
||||
Reference in New Issue
Block a user