mirrors/pdf.js
1
0
Fork 0
mirror of https://github.com/mozilla/pdf.js.git synced 2025-04-26 10:08:06 +02:00
Code Activity

Consistently use @type for getter data types in JSDoc comments

Browse source 
Sometimes we also used `@return` or `@returns`, but `@type` is what
the JSDoc documentation recommends. This also improves the documentation
because before this commit the types were not shown and now they are.
This commit is contained in:
Tim van der Meij 2019-10-12 17:02:54 +02:00
parent f4daafc077
commit 8b4ae6f3eb
No known key found for this signature in database
GPG key ID: 8C3FD2925A5F2762
13 changed files with 56 additions and 56 deletions
Download patch file Download diff file Expand all files Collapse all files

4
src/core/annotation.js
View file

@ -253,7 +253,7 @@ class Annotation {
}
/**
* @return {boolean}
* @type {boolean}
*/
get viewable() {
if (this.flags === 0) {
@ -263,7 +263,7 @@ class Annotation {
}
/**
* @return {boolean}
* @type {boolean}
*/
get printable() {
if (this.flags === 0) {

4
src/core/operator_list.js
View file

@ -568,8 +568,8 @@ var OperatorList = (function OperatorListClosure() {
},
/**
* @returns {number} The total length of the entire operator list,
* since `this.length === 0` after flushing.
* @type {number} The total length of the entire operator list, since
* `this.length === 0` after flushing.
*/
get totalLength() {
return (this._totalLength + this.length);