Add doc for error constructors

hexojs · Jan 9, 2016 · 145f041 · 145f041
1 parent 511c8dc
commit 145f041
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 0 deletions.
diff --git a/lib/error.js b/lib/error.js
@@ -2,6 +2,14 @@
 
 var util = require('./util');
 
+/**
+ * WarehouseError constructor
+ *
+ * @class
+ * @param {String} msg
+ * @param {String} code
+ * @extends Error
+ */
 function WarehouseError(msg, code) {
   Error.call(this);
 

diff --git a/lib/error/population.js b/lib/error/population.js
@@ -3,6 +3,13 @@
 var util = require('../util');
 var WarehouseError = require('../error');
 
+/**
+ * PopulationError constructor
+ *
+ * @class
+ * @param {String} msg
+ * @extends WarehouseError
+ */
 function PopulationError(msg) {
   WarehouseError.call(this);
 

diff --git a/lib/error/validation.js b/lib/error/validation.js
@@ -3,6 +3,13 @@
 var util = require('../util');
 var WarehouseError = require('../error');
 
+/**
+ * ValidationError constructor
+ *
+ * @class
+ * @param {String} msg
+ * @extends WarehouseError
+ */
 function ValidationError(msg) {
   WarehouseError.call(this);