style(virtualtype): touch-up jsdoc

Author: hasezoey

lib/virtualtype.js

@@ -13,18 +13,18 @@ const utils = require('./utils');
  *     fullname instanceof mongoose.VirtualType // true
  *
  * @param {Object} options
- * @param {string|function} [options.ref] if `ref` is not nullish, this becomes a [populated virtual](/docs/populate.html#populate-virtuals)
- * @param {string|function} [options.localField] the local field to populate on if this is a populated virtual.
- * @param {string|function} [options.foreignField] the foreign field to populate on if this is a populated virtual.
- * @param {boolean} [options.justOne=false] by default, a populated virtual is an array. If you set `justOne`, the populated virtual will be a single doc or `null`.
- * @param {boolean} [options.getters=false] if you set this to `true`, Mongoose will call any custom getters you defined on this virtual
- * @param {boolean} [options.count=false] if you set this to `true`, `populate()` will set this virtual to the number of populated documents, as opposed to the documents themselves, using [`Query#countDocuments()`](./api.html#query_Query-countDocuments)
+ * @param {String|Function} [options.ref] if `ref` is not nullish, this becomes a [populated virtual](/docs/populate.html#populate-virtuals)
+ * @param {String|Function} [options.localField] the local field to populate on if this is a populated virtual.
+ * @param {String|Function} [options.foreignField] the foreign field to populate on if this is a populated virtual.
+ * @param {Boolean} [options.justOne=false] by default, a populated virtual is an array. If you set `justOne`, the populated virtual will be a single doc or `null`.
+ * @param {Boolean} [options.getters=false] if you set this to `true`, Mongoose will call any custom getters you defined on this virtual
+ * @param {Boolean} [options.count=false] if you set this to `true`, `populate()` will set this virtual to the number of populated documents, as opposed to the documents themselves, using [`Query#countDocuments()`](./api.html#query_Query-countDocuments)
  * @param {Object|Function} [options.match=null] add an extra match condition to `populate()`
  * @param {Number} [options.limit=null] add a default `limit` to the `populate()` query
  * @param {Number} [options.skip=null] add a default `skip` to the `populate()` query
  * @param {Number} [options.perDocumentLimit=null] For legacy reasons, `limit` with `populate()` may give incorrect results because it only executes a single query for every document being populated. If you set `perDocumentLimit`, Mongoose will ensure correct `limit` per document by executing a separate query for each document to `populate()`. For example, `.find().populate({ path: 'test', perDocumentLimit: 2 })` will execute 2 additional queries if `.find()` returns 2 documents.
  * @param {Object} [options.options=null] Additional options like `limit` and `lean`.
- * @param {string} name
+ * @param {String} name
  * @api public
  */
 
@@ -36,10 +36,8 @@ function VirtualType(options, name) {
 }
 
 /**
- * If no getters/getters, add a default
+ * If no getters/setters, add a default
  *
- * @param {Function} fn
- * @return {VirtualType} this
  * @api private
  */
 
@@ -85,7 +83,7 @@ VirtualType.prototype.clone = function() {
  *       return this.name.first + ' ' + this.name.last;
  *     });
  *
- * @param {function} fn
+ * @param {Function} fn
  * @return {VirtualType} this
  * @api public
  */
@@ -120,7 +118,7 @@ VirtualType.prototype.get = function(fn) {
  *     doc.name.first; // 'Jean-Luc'
  *     doc.name.last; // 'Picard'
  *
- * @param {function} fn
+ * @param {Function} fn
  * @return {VirtualType} this
  * @api public
  */
@@ -135,7 +133,7 @@ VirtualType.prototype.set = function(fn) {
  *
  * @param {Object} value
  * @param {Document} doc The document this virtual is attached to
- * @return {any} the value after applying all getters
+ * @return {Any} the value after applying all getters
  * @api public
  */
 
@@ -158,7 +156,7 @@ VirtualType.prototype.applyGetters = function(value, doc) {
  *
  * @param {Object} value
  * @param {Document} doc
- * @return {any} the value after applying all setters
+ * @return {Any} the value after applying all setters
  * @api public
  */