Merge pull request Automattic#14899 from Automattic/IslandRhythms/fix-comments

standardize comment placement in lib/error

Author: vkarpov15

lib/error/browserMissingSchema.js

@@ -6,11 +6,12 @@
 
 const MongooseError = require('./mongooseError');
 
+/**
+ * MissingSchema Error constructor.
+ */
 
 class MissingSchemaError extends MongooseError {
-  /**
-   * MissingSchema Error constructor.
-   */
+
   constructor() {
     super('Schema hasn\'t been registered for document.\n'
       + 'Use mongoose.Document(name, schema)');

lib/error/divergentArray.js

@@ -7,12 +7,14 @@
 
 const MongooseError = require('./mongooseError');
 
+/**
+ * DivergentArrayError constructor.
+ * @param {Array<String>} paths
+ * @api private
+ */
+
 class DivergentArrayError extends MongooseError {
-  /**
-   * DivergentArrayError constructor.
-   * @param {Array<String>} paths
-   * @api private
-   */
+
   constructor(paths) {
     const msg = 'For your own good, using `document.save()` to update an array '
             + 'which was selected using an $elemMatch projection OR '

lib/error/invalidSchemaOption.js

@@ -7,12 +7,14 @@
 
 const MongooseError = require('./mongooseError');
 
+/**
+ * InvalidSchemaOption Error constructor.
+ * @param {String} name
+ * @api private
+ */
+
 class InvalidSchemaOptionError extends MongooseError {
-  /**
-   * InvalidSchemaOption Error constructor.
-   * @param {String} name
-   * @api private
-   */
+
   constructor(name, option) {
     const msg = `Cannot create use schema for property "${name}" because the schema has the ${option} option enabled.`;
     super(msg);

lib/error/missingSchema.js

@@ -7,12 +7,14 @@
 
 const MongooseError = require('./mongooseError');
 
+/**
+ * MissingSchema Error constructor.
+ * @param {String} name
+ * @api private
+ */
+
 class MissingSchemaError extends MongooseError {
-  /**
-   * MissingSchema Error constructor.
-   * @param {String} name
-   * @api private
-   */
+
   constructor(name) {
     const msg = 'Schema hasn\'t been registered for model "' + name + '".\n'
             + 'Use mongoose.model(name, schema)';

lib/error/notFound.js

@@ -7,11 +7,13 @@
 const MongooseError = require('./mongooseError');
 const util = require('util');
 
+/**
+ * OverwriteModel Error constructor.
+ * @api private
+ */
+
 class DocumentNotFoundError extends MongooseError {
-  /**
-   * OverwriteModel Error constructor.
-   * @api private
-   */
+
   constructor(filter, model, numAffected, result) {
     let msg;
     const messages = MongooseError.messages;

lib/error/objectExpected.js

@@ -6,15 +6,16 @@
 
 const MongooseError = require('./mongooseError');
 
+/**
+ * Strict mode error constructor
+ *
+ * @param {string} type
+ * @param {string} value
+ * @api private
+ */
 
 class ObjectExpectedError extends MongooseError {
-  /**
-   * Strict mode error constructor
-   *
-   * @param {string} type
-   * @param {string} value
-   * @api private
-   */
+
   constructor(path, val) {
     const typeDescription = Array.isArray(val) ? 'array' : 'primitive value';
     super('Tried to set nested object field `' + path +

lib/error/objectParameter.js

@@ -6,16 +6,18 @@
 
 const MongooseError = require('./mongooseError');
 
+/**
+ * Constructor for errors that happen when a parameter that's expected to be
+ * an object isn't an object
+ *
+ * @param {Any} value
+ * @param {String} paramName
+ * @param {String} fnName
+ * @api private
+ */
+
 class ObjectParameterError extends MongooseError {
-  /**
-   * Constructor for errors that happen when a parameter that's expected to be
-   * an object isn't an object
-   *
-   * @param {Any} value
-   * @param {String} paramName
-   * @param {String} fnName
-   * @api private
-   */
+
   constructor(value, paramName, fnName) {
     super('Parameter "' + paramName + '" to ' + fnName +
       '() must be an object, got "' + value.toString() + '" (type ' + typeof value + ')');

lib/error/overwriteModel.js

@@ -7,13 +7,14 @@
 
 const MongooseError = require('./mongooseError');
 
+/**
+ * OverwriteModel Error constructor.
+ * @param {String} name
+ * @api private
+ */
 
 class OverwriteModelError extends MongooseError {
-  /**
-   * OverwriteModel Error constructor.
-   * @param {String} name
-   * @api private
-   */
+
   constructor(name) {
     super('Cannot overwrite `' + name + '` model once compiled.');
   }

lib/error/parallelSave.js

@@ -6,13 +6,16 @@
 
 const MongooseError = require('./mongooseError');
 
+
+/**
+ * ParallelSave Error constructor.
+ *
+ * @param {Document} doc
+ * @api private
+ */
+
 class ParallelSaveError extends MongooseError {
-  /**
-   * ParallelSave Error constructor.
-   *
-   * @param {Document} doc
-   * @api private
-   */
+
   constructor(doc) {
     const msg = 'Can\'t save() the same doc multiple times in parallel. Document: ';
     super(msg + doc._doc._id);

lib/error/parallelValidate.js

@@ -7,13 +7,15 @@
 const MongooseError = require('./mongooseError');
 
 
+/**
+ * ParallelValidate Error constructor.
+ *
+ * @param {Document} doc
+ * @api private
+ */
+
 class ParallelValidateError extends MongooseError {
-  /**
-   * ParallelValidate Error constructor.
-   *
-   * @param {Document} doc
-   * @api private
-   */
+
   constructor(doc) {
     const msg = 'Can\'t validate() the same doc multiple times in parallel. Document: ';
     super(msg + doc._doc._id);