Sakurai/pdf.js
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Don't include private methods in the the PDFPageProxy API documentation

Browse Source
This commit is contained in:
Tim van der Meij 2019-10-13 14:28:15 +02:00
parent 36c01c2c2a
commit 9f4d45ddf4
No known key found for this signature in database
GPG Key ID: 8C3FD2925A5F2762
1 changed files with 8 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
src/display/api.js
View File

@ -1193,7 +1193,8 @@ class PDFPageProxy {
} }
/** /**
* Destroys page object. * Destroys the page object.
* @private
*/ */
_destroy() { _destroy() {
this.destroyed = true; this.destroyed = true;
@ -1236,9 +1237,8 @@ class PDFPageProxy {
} }
/** /**
* For internal use only. Attempts to clean up if rendering is in a state * Attempts to clean up if rendering is in a state where that's possible.
* where that's possible. * @private
* @ignore
*/ */
_tryCleanup(resetStats = false) { _tryCleanup(resetStats = false) {
if (!this.pendingCleanup || if (!this.pendingCleanup ||
@ -1262,8 +1262,7 @@ class PDFPageProxy {
} }
/** /**
* For internal use only. * @private
* @ignore
*/ */
_startRenderPage(transparency, intent) { _startRenderPage(transparency, intent) {
const intentState = this.intentStates[intent]; const intentState = this.intentStates[intent];
@ -1279,8 +1278,7 @@ class PDFPageProxy {
} }
/** /**
* For internal use only. * @private
* @ignore
*/ */
_renderPageChunk(operatorListChunk, intentState) { _renderPageChunk(operatorListChunk, intentState) {
// Add the new chunk to the current operator list. // Add the new chunk to the current operator list.
@ -1302,8 +1300,7 @@ class PDFPageProxy {
} }
/** /**
* For internal use only. * @private
* @ignore
*/ */
_pumpOperatorList(args) { _pumpOperatorList(args) {
assert(args.intent, assert(args.intent,
@ -1356,8 +1353,7 @@ class PDFPageProxy {
} }
/** /**
* For internal use only. * @private
* @ignore
*/ */
_abortOperatorList({ intentState, reason, force = false, }) { _abortOperatorList({ intentState, reason, force = false, }) {
assert(reason instanceof Error, assert(reason instanceof Error,