Skip to content

Commit 7bc87b8

Browse files
author
ehennum
committed
jsdoc fixes #225
1 parent f36637e commit 7bc87b8

File tree

2 files changed

+10
-2
lines changed

2 files changed

+10
-2
lines changed

lib/documents.js

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -292,6 +292,9 @@ function singleReadOutputTransform(headers, data) {
292292
* @param {string} [transform] - the name of a transform extension to apply
293293
* to each document; the transform must have been installed using
294294
* the {@link transforms#write} function.
295+
* @param {number[]} [range] - the range of bytes to extract
296+
* from a binary document; the range is specified with a zero-based
297+
* start byte and the position after the end byte as in Array.slice()
295298
* @returns {ResultProvider} an object whose result() function takes
296299
* a {@link documents#resultList} success callback.
297300
*/

lib/patch-builder.js

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -757,7 +757,12 @@ function removeProperty(name) {
757757
}
758758

759759
/**
760-
* Specifies operations to patch the quality of a document.
760+
* Specifies operations to patch the search quality of a document.
761+
* @namespace patchBuilderQuality
762+
*/
763+
764+
/**
765+
* Sets the search quality of a document.
761766
* @method
762767
* @memberof! patchBuilderQuality
763768
* @param {number} quality - the numeric value of the quality
@@ -810,7 +815,7 @@ module.exports = {
810815
* of a document.
811816
* @name quality
812817
* @memberof! patchBuilder#
813-
* @type {patchBuilderQuality}
818+
* @type {patchBuilderQuality}
814819
*/
815820
quality: {
816821
set: setQuality

0 commit comments

Comments
 (0)