github/puppeteer
0
0
Fork 0
mirror of https://github.com/puppeteer/puppeteer synced 2024-06-14 14:02:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: replace @return with @returns (#6006)

Browse Source 
The former is not understood by TSDoc.
This commit is contained in:
Jack Franklin
2020-06-12 11:38:24 +01:00
committed by GitHub
parent 23f18d8cc0
commit 8a099a0c2c
33 changed files with 98 additions and 88 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
utils/doclint/check_public_api/JSBuilder.js
View File

@@ -68,7 +68,7 @@ function checkSources(sources) {
/**
* @param {!Array<!Documentation.Class>} classes
* @param {!Map<string, string>} inheritance
* @return {!Array<!Documentation.Class>}
* @returns {!Array<!Documentation.Class>}
*/
function recreateClassesWithInheritance(classes, inheritance) {
const classesByName = new Map(classes.map((cls) => [cls.name, cls]));
@@ -155,7 +155,7 @@ function checkSources(sources) {
/**
* @param {!ts.Type} type
* @return {!Documentation.Type}
* @returns {!Documentation.Type}
*/
function serializeType(type, circular = []) {
let typeName = checker.typeToString(type);
@@ -207,7 +207,7 @@ function checkSources(sources) {
/**
* @param {!ts.Symbol} symbol
* @return {boolean}
* @returns {boolean}
*/
function symbolHasPrivateModifier(symbol) {
const modifiers =
@@ -220,7 +220,7 @@ function checkSources(sources) {
/**
* @param {string} className
* @param {!ts.Symbol} symbol
* @return {}
* @returns {}
*/
function serializeClass(className, symbol, node) {
/** @type {!Array<!Documentation.Member>} */