Skip to content

Commit 57c546c

Browse files
author
ehennum
committed
fixup on method names in JSDoc #225
1 parent 3258ea9 commit 57c546c

File tree

1 file changed

+9
-18
lines changed

1 file changed

+9
-18
lines changed

lib/patch-builder.js

Lines changed: 9 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -570,8 +570,7 @@ function pathLanguage() {
570570

571571
/**
572572
* Specifies a collection to add to a document's metadata.
573-
* @method
574-
* @memberof! patchBuilderCollections
573+
* @method patchBuilderCollections#add
575574
* @param {string} collection - the name of the collection
576575
* @returns {patchBuilder.PatchOperation} a patch operation
577576
*/
@@ -583,8 +582,7 @@ function addCollection(collection) {
583582
}
584583
/**
585584
* Specifies a collection to remove from a document's metadata.
586-
* @method
587-
* @memberof! patchBuilderCollections
585+
* @method patchBuilderCollections#remove
588586
* @param {string} collection - the name of the collection
589587
* @returns {patchBuilder.PatchOperation} a patch operation
590588
*/
@@ -604,8 +602,7 @@ function removeCollection(collection) {
604602
* Specifies a role to add to a document's permissions; takes a configuration
605603
* object with the following named parameters or, as a shortcut,
606604
* a role string and capabilities string or array.
607-
* @method
608-
* @memberof! patchBuilderPermissions
605+
* @method patchBuilderPermissions#add
609606
* @param {string} role - the name of a role defined in the server configuration
610607
* @param {string|string[]} capabilities - the capability or an array of
611608
* capabilities from the insert|update|read|execute enumeration
@@ -624,8 +621,7 @@ function addPermission() {
624621
* Specifies different capabilities for a role with permissions on a document;
625622
* takes a configuration object with the following named parameters or,
626623
* as a shortcut, a role string and capabilities string or array.
627-
* @method
628-
* @memberof! patchBuilderPermissions
624+
* @method patchBuilderPermissions#replace
629625
* @param {string} role - the name of an existing role with permissions
630626
* on the document
631627
* @param {string|string[]} capabilities - the role's modified capability or
@@ -645,8 +641,7 @@ function replacePermission() {
645641
}
646642
/**
647643
* Specifies a role to remove from a document's permissions.
648-
* @method
649-
* @memberof! patchBuilderPermissions
644+
* @method patchBuilderPermissions#remove
650645
* @param {string} role - the role to remove from access to the document
651646
* @returns {patchBuilder.PatchOperation} a patch operation
652647
*/
@@ -714,8 +709,7 @@ function getPermission(args) {
714709

715710
/**
716711
* Specifies a new property to add to a document's metadata.
717-
* @method
718-
* @memberof! patchBuilderProperties
712+
* @method patchBuilderProperties#add
719713
* @param {string} name - the name of the new metadata property
720714
* @param value - the value of the new metadata property
721715
* @returns {patchBuilder.PatchOperation} a patch operation
@@ -730,8 +724,7 @@ function addProperty(name, value) {
730724
}
731725
/**
732726
* Specifies a different value for a property in a document's metadata.
733-
* @method
734-
* @memberof! patchBuilderProperties
727+
* @method patchBuilderProperties#replace
735728
* @param {string} name - the name of the existing metadata property
736729
* @param value - the modified value of the metadata property
737730
* @returns {patchBuilder.PatchOperation} a patch operation
@@ -744,8 +737,7 @@ function replaceProperty(name, value) {
744737
}
745738
/**
746739
* Specifies a metadata property to remove from the document's metadata.
747-
* @method
748-
* @memberof! patchBuilderProperties
740+
* @method patchBuilderProperties#remove
749741
* @param {string} name - the name of the metadata property to remove
750742
* @returns {patchBuilder.PatchOperation} a patch operation
751743
*/
@@ -763,8 +755,7 @@ function removeProperty(name) {
763755

764756
/**
765757
* Sets the search quality of a document.
766-
* @method
767-
* @memberof! patchBuilderQuality
758+
* @method patchBuilderQuality#set
768759
* @param {number} quality - the numeric value of the quality
769760
*/
770761
function setQuality(quality) {

0 commit comments

Comments
 (0)