Add documentation for methods that can return null (fixes #82)

rotaready · Jun 4, 2015 · 4841224 · 4841224
1 parent 0b9b89c
commit 4841224
Showing 1 changed file with 4 additions and 2 deletions.
diff --git a/lib/moment-range.js b/lib/moment-range.js
@@ -109,7 +109,8 @@ DateRange.prototype.overlaps = function(range) {
  *
  * @param {!DateRange} other A date range to intersect with this one
  *
- * @return {DateRange}
+ * @return {DateRange} Returns the intersecting date or `null` if the ranges do
+ *                     not intersect
  */
 DateRange.prototype.intersect = function(other) {
   var start = this.start;
@@ -136,7 +137,8 @@ DateRange.prototype.intersect = function(other) {
  *
  * @param {!DateRange} other A date range to add to this one
  *
- * @return {DateRange}
+ * @return {DateRange} Returns the new `DateRange` or `null` if they do not
+ *                     overlap
  */
 DateRange.prototype.add = function(other) {
   if (this.overlaps(other)) {