From 2ce9da9b7ad2464de61ae0098b59d93ccca371c4 Mon Sep 17 00:00:00 2001 From: Jonas Jenwald Date: Mon, 17 Oct 2016 13:04:55 +0200 Subject: [PATCH] Fix a couple of JSDoc `@typedef`s to use `@property` (instead of `@param`) to fix some missing documentation when running `gulp jsdoc` --- src/display/api.js | 15 +++++++-------- web/pdf_viewer.js | 8 ++++---- 2 files changed, 11 insertions(+), 12 deletions(-) diff --git a/src/display/api.js b/src/display/api.js index 5a2e07591..d695f1c2c 100644 --- a/src/display/api.js +++ b/src/display/api.js @@ -627,9 +627,9 @@ var PDFDocumentProxy = (function PDFDocumentProxyClosure() { * Page getTextContent parameters. * * @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`. - * @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`. */ @@ -638,8 +638,7 @@ var PDFDocumentProxy = (function PDFDocumentProxyClosure() { * * @typedef {Object} TextContent * @property {array} items - array of {@link TextItem} - * @property {Object} styles - {@link TextStyles} objects, indexed by font - * name. + * @property {Object} styles - {@link TextStyles} objects, indexed by font name. */ /** @@ -668,10 +667,10 @@ var PDFDocumentProxy = (function PDFDocumentProxyClosure() { * Page annotation parameters. * * @typedef {Object} GetAnnotationsParameters - * @param {string} intent - Determines the annotations that will be fetched, - * can be either 'display' (viewable annotations) or 'print' - * (printable annotations). - * If the parameter is omitted, all annotations are fetched. + * @property {string} intent - Determines the annotations that will be fetched, + * can be either 'display' (viewable annotations) or 'print' + * (printable annotations). + * If the parameter is omitted, all annotations are fetched. */ /** diff --git a/web/pdf_viewer.js b/web/pdf_viewer.js index d1273d2d2..16c3198b7 100644 --- a/web/pdf_viewer.js +++ b/web/pdf_viewer.js @@ -552,10 +552,10 @@ var PDFViewer = (function pdfViewer() { /** * @typedef ScrollPageIntoViewParameters - * @param {number} pageNumber - The page number. - * @param {Array} destArray - (optional) The original PDF destination array, - * in the format: - * @param {boolean} allowNegativeOffset - (optional) Allow negative page + * @property {number} pageNumber - The page number. + * @property {Array} destArray - (optional) The original PDF destination + * array, in the format: + * @property {boolean} allowNegativeOffset - (optional) Allow negative page * offsets. The default value is `false`. */