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

Fix a couple of JSDoc @typedefs to use @property (instead of @param) to fix some missing documentation when running gulp jsdoc

Browse Source
This commit is contained in:
Jonas Jenwald 2016-10-17 13:04:55 +02:00
parent 6678da379b
commit 2ce9da9b7a
2 changed files with 11 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
src/display/api.js
View File

@ -627,9 +627,9 @@ var PDFDocumentProxy = (function PDFDocumentProxyClosure() {
* Page getTextContent parameters. * Page getTextContent parameters.
* *
* @typedef {Object} getTextContentParameters * @typedef {Object} getTextContentParameters
* @param {boolean} normalizeWhitespace - replaces all occurrences of * @property {boolean} normalizeWhitespace - replaces all occurrences of
* whitespace with standard spaces (0x20). The default value is `false`. * whitespace with standard spaces (0x20). The default value is `false`.
* @param {boolean} disableCombineTextItems - do not attempt to combine * @property {boolean} disableCombineTextItems - do not attempt to combine
* same line {@link TextItem}'s. The default value is `false`. * same line {@link TextItem}'s. The default value is `false`.
*/ */
@ -638,8 +638,7 @@ var PDFDocumentProxy = (function PDFDocumentProxyClosure() {
* *
* @typedef {Object} TextContent * @typedef {Object} TextContent
* @property {array} items - array of {@link TextItem} * @property {array} items - array of {@link TextItem}
* @property {Object} styles - {@link TextStyles} objects, indexed by font * @property {Object} styles - {@link TextStyles} objects, indexed by font name.
* name.
*/ */
/** /**
@ -668,10 +667,10 @@ var PDFDocumentProxy = (function PDFDocumentProxyClosure() {
* Page annotation parameters. * Page annotation parameters.
* *
* @typedef {Object} GetAnnotationsParameters * @typedef {Object} GetAnnotationsParameters
* @param {string} intent - Determines the annotations that will be fetched, * @property {string} intent - Determines the annotations that will be fetched,
* can be either 'display' (viewable annotations) or 'print' * can be either 'display' (viewable annotations) or 'print'
* (printable annotations). * (printable annotations).
* If the parameter is omitted, all annotations are fetched. * If the parameter is omitted, all annotations are fetched.
*/ */
/** /**

8
web/pdf_viewer.js
View File

@ -552,10 +552,10 @@ var PDFViewer = (function pdfViewer() {
/** /**
* @typedef ScrollPageIntoViewParameters * @typedef ScrollPageIntoViewParameters
* @param {number} pageNumber - The page number. * @property {number} pageNumber - The page number.
* @param {Array} destArray - (optional) The original PDF destination array, * @property {Array} destArray - (optional) The original PDF destination
* in the format: <page-ref> </XYZ|/FitXXX> <args..> * array, in the format: <page-ref> </XYZ|/FitXXX> <args..>
* @param {boolean} allowNegativeOffset - (optional) Allow negative page * @property {boolean} allowNegativeOffset - (optional) Allow negative page
* offsets. The default value is `false`. * offsets. The default value is `false`.
*/ */