فهرست منبع

Fixes #933. Munge YUI docs are updated, and there is a simple wiki page pointing to the README and source.

http://source.rd.rcg.local/trac/eagle6/changeset/1358/Eagle6_SVN
Spencer Rathbun 13 سال پیش
والد
کامیت
5e8d581c77
46فایلهای تغییر یافته به همراه302 افزوده شده و 47 حذف شده
  1. 4 0
      lib/pipeline/accumulators/Accumulator.js
  2. 8 1
      lib/pipeline/accumulators/AddToSetAccumulator.js
  3. 8 0
      lib/pipeline/accumulators/AvgAccumulator.js
  4. 4 0
      lib/pipeline/accumulators/FirstAccumulator.js
  5. 9 0
      lib/pipeline/accumulators/LastAccumulator.js
  6. 4 0
      lib/pipeline/accumulators/MinMaxAccumulator.js
  7. 8 0
      lib/pipeline/accumulators/PushAccumulator.js
  8. 12 7
      lib/pipeline/accumulators/SingleValueAccumulator.js
  9. 8 0
      lib/pipeline/accumulators/SumAccumulator.js
  10. 5 1
      lib/pipeline/documentSources/CursorDocumentSource.js
  11. 5 0
      lib/pipeline/documentSources/DocumentSource.js
  12. 1 1
      lib/pipeline/documentSources/FilterBaseDocumentSource.js
  13. 6 1
      lib/pipeline/documentSources/GroupDocumentSource.js
  14. 1 1
      lib/pipeline/documentSources/LimitDocumentSource.js
  15. 1 1
      lib/pipeline/documentSources/MatchDocumentSource.js
  16. 1 1
      lib/pipeline/documentSources/ProjectDocumentSource.js
  17. 1 1
      lib/pipeline/documentSources/SkipDocumentSource.js
  18. 1 1
      lib/pipeline/documentSources/SortDocumentSource.js
  19. 1 1
      lib/pipeline/documentSources/UnwindDocumentSource.js
  20. 8 1
      lib/pipeline/expressions/AddExpression.js
  21. 10 4
      lib/pipeline/expressions/AndExpression.js
  22. 8 1
      lib/pipeline/expressions/CoerceToBoolExpression.js
  23. 8 1
      lib/pipeline/expressions/CompareExpression.js
  24. 8 3
      lib/pipeline/expressions/CondExpression.js
  25. 8 1
      lib/pipeline/expressions/ConstantExpression.js
  26. 8 0
      lib/pipeline/expressions/DayOfMonthExpression.js
  27. 8 0
      lib/pipeline/expressions/DayOfWeekExpression.js
  28. 8 0
      lib/pipeline/expressions/DayOfYearExpression.js
  29. 9 1
      lib/pipeline/expressions/DivideExpression.js
  30. 5 0
      lib/pipeline/expressions/FieldRangeExpression.js
  31. 9 1
      lib/pipeline/expressions/HourExpression.js
  32. 8 2
      lib/pipeline/expressions/IfNullExpression.js
  33. 9 1
      lib/pipeline/expressions/MinuteExpression.js
  34. 9 1
      lib/pipeline/expressions/ModExpression.js
  35. 9 1
      lib/pipeline/expressions/MonthExpression.js
  36. 9 1
      lib/pipeline/expressions/MultiplyExpression.js
  37. 4 0
      lib/pipeline/expressions/NotExpression.js
  38. 7 3
      lib/pipeline/expressions/OrExpression.js
  39. 9 1
      lib/pipeline/expressions/SecondExpression.js
  40. 7 1
      lib/pipeline/expressions/StrcasecmpExpression.js
  41. 7 1
      lib/pipeline/expressions/SubstrExpression.js
  42. 7 1
      lib/pipeline/expressions/SubtractExpression.js
  43. 7 1
      lib/pipeline/expressions/ToLowerExpression.js
  44. 7 1
      lib/pipeline/expressions/ToUpperExpression.js
  45. 9 1
      lib/pipeline/expressions/WeekExpression.js
  46. 9 1
      lib/pipeline/expressions/YearExpression.js

+ 4 - 0
lib/pipeline/accumulators/Accumulator.js

@@ -3,6 +3,10 @@ var Accumulator = module.exports = (function(){
 	/** 
 	* A base class for all pipeline accumulators. Uses NaryExpression as a base class.
 	*
+	* @class Accumulator
+	* @namespace munge.pipeline.accumulators
+	* @module munge
+	* @constructor
 	**/
 	var klass = function Accumulator(){
 		if(arguments.length !== 0) throw new Error("zero args expected");

+ 8 - 1
lib/pipeline/accumulators/AddToSetAccumulator.js

@@ -5,7 +5,14 @@ var AddToSetAccumulator = module.exports = (function(){
 	require("es6-shim");
 
 	// CONSTRUCTOR
-	/** Create an expression that finds the sum of n operands. **/
+	/** 
+	 * Create an expression that finds the sum of n operands.
+	 *
+	 * @class AddSoSetAccumulator
+	 * @namespace munge.pipeline.accumulators
+	 * @module munge
+	 * @constructor
+	**/
 	var klass = module.exports = function AddToSetAccumulator(/* pCtx */){
 		if(arguments.length !== 0) throw new Error("zero args expected");
 		this.set = new Map();

+ 8 - 0
lib/pipeline/accumulators/AvgAccumulator.js

@@ -1,6 +1,14 @@
 var AvgAccumulator = module.exports = (function(){
 
 	// Constructor
+	/** 
+	* A class for constructing accumulators to calculate avg.
+	*
+	* @class AvgAccumulator
+	* @namespace munge.pipeline.accumulators
+	* @module munge
+	* @constructor
+	**/
 	var klass = module.exports = function AvgAccumulator(){
 		this.subTotalName = "subTotal";
 		this.countName = "count";

+ 4 - 0
lib/pipeline/accumulators/FirstAccumulator.js

@@ -4,6 +4,10 @@ var FirstAccumulator = module.exports = (function(){
 	* Constructor for FirstAccumulator, wraps SingleValueAccumulator's constructor and
 	* adds flag to track whether we have started or not
 	*
+	* @class FirstAccumulator
+	* @namespace munge.pipeline.accumulators
+	* @module munge
+	* @constructor
 	**/
 	var klass = module.exports = function FirstAccumulator(){
 		base.call(this);

+ 9 - 0
lib/pipeline/accumulators/LastAccumulator.js

@@ -1,6 +1,15 @@
 var LastAccumulator = module.exports = (function(){
 
 	// Constructor
+	/** 
+	* Constructor for LastAccumulator, wraps SingleValueAccumulator's constructor and
+	* finds the last document
+	*
+	* @class LastAccumulator
+	* @namespace munge.pipeline.accumulators
+	* @module munge
+	* @constructor
+	**/
 	var klass = module.exports = function LastAccumulator(){
 		base.call(this);
 	}, SingleValueAccumulator = require("./SingleValueAccumulator"), base = SingleValueAccumulator, proto = klass.prototype = Object.create(base.prototype, {constructor:{value:klass}});

+ 4 - 0
lib/pipeline/accumulators/MinMaxAccumulator.js

@@ -4,6 +4,10 @@ var MinMaxAccumulator = module.exports = (function(){
 	* Constructor for MinMaxAccumulator, wraps SingleValueAccumulator's constructor and
 	* adds flag to track whether we have started or not
 	*
+	* @class MinMaxAccumulator
+	* @namespace munge.pipeline.accumulators
+	* @module munge
+	* @constructor
 	**/
 	var klass = module.exports = function MinMaxAccumulator(sense){
 		if(arguments.length > 1 ) throw new Error("expects a single value");

+ 8 - 0
lib/pipeline/accumulators/PushAccumulator.js

@@ -1,6 +1,14 @@
 var PushAccumulator = module.exports = (function(){
 
 	// Constructor
+	/** 
+	* Constructor for PushAccumulator. Pushes items onto an array.
+	*
+	* @class PushAccumulator
+	* @namespace munge.pipeline.accumulators
+	* @module munge
+	* @constructor
+	**/
 	var klass = module.exports = function PushAccumulator(){
 		this.values = [];
 		base.call(this);

+ 12 - 7
lib/pipeline/accumulators/SingleValueAccumulator.js

@@ -1,12 +1,17 @@
-var AccumulatorSingleValue = module.exports = (function(){
+var SingleValueAccumulator = module.exports = (function(){
 
 	// Constructor
-	/*
-      This isn't a finished accumulator, but rather a convenient base class
-      for others such as $first, $last, $max, $min, and similar.  It just
-      provides a holder for a single Value, and the getter for that.  The
-      holder is protected so derived classes can manipulate it.
-     */
+	/**
+     * This isn't a finished accumulator, but rather a convenient base class
+     * for others such as $first, $last, $max, $min, and similar.  It just
+     * provides a holder for a single Value, and the getter for that.  The
+     * holder is protected so derived classes can manipulate it.
+	 *
+	 * @class SingleValueAccumulator
+	 * @namespace munge.pipeline.accumulators
+	 * @module munge
+	 * @constructor
+	**/
 
 	var klass = module.exports = function AccumulatorSingleValue(value){
 		if(arguments.length > 1 ) throw new Error("expects a single value");

+ 8 - 0
lib/pipeline/accumulators/SumAccumulator.js

@@ -1,6 +1,14 @@
 var SumAccumulator = module.exports = (function(){
 
 	// Constructor
+	/** 
+	* Accumulator for summing a field across documents
+	*
+	* @class SumAccumulator
+	* @namespace munge.pipeline.accumulators
+	* @module munge
+	* @constructor
+	**/
 	var klass = module.exports = function SumAccumulator(){
 		this.total = 0;
 		this.count = 0;

+ 5 - 1
lib/pipeline/documentSources/CursorDocumentSource.js

@@ -7,6 +7,10 @@ var CursorDocumentSource = module.exports = (function(){
      * This is usually put at the beginning of a chain of document sources
      * in order to fetch data from the database.
      * 
+	 * @class CursorDocumentSource
+	 * @namespace munge.pipeline.documentsource
+	 * @module munge
+	 * @constructor
      * @param	{CursorDocumentSource.CursorWithContext}	cursorWithContext the cursor to use to fetch data
     **/
 	var klass = module.exports = CursorDocumentSource = function CursorDocumentSource(cursorWithContext/*, pExpCtx*/){
@@ -248,4 +252,4 @@ var CursorDocumentSource = module.exports = (function(){
 	
 	
 	return klass;
-})();
+})();

+ 5 - 0
lib/pipeline/documentSources/DocumentSource.js

@@ -2,6 +2,11 @@ var DocumentSource = module.exports = (function(){
 	// CONSTRUCTOR
 	/**
 	 * A base class for all document sources
+	 *
+	 * @class DocumentSource
+	 * @namespace munge.pipeline.documentsource
+	 * @module munge
+	 * @constructor
 	 * @param	{ExpressionContext}	
 	**/
 	var klass = module.exports = DocumentSource = function DocumentSource(/*pCtx*/){

+ 1 - 1
lib/pipeline/documentSources/FilterBaseDocumentSource.js

@@ -4,7 +4,7 @@ var FilterBaseDocumentSource = module.exports = (function(){
 	 * A base class for filter document sources
 	 * 
 	 * @class FilterBaseDocumentSource
-	 * @namespace munge.pipepline.documentsource
+	 * @namespace munge.pipeline.documentsource
 	 * @module munge
 	 * @constructor
 	 * @param	{ExpressionContext}	

+ 6 - 1
lib/pipeline/documentSources/GroupDocumentSource.js

@@ -5,7 +5,12 @@ var DocumentSource = require("./DocumentSource"),
 	GroupDocumentSource = module.exports = (function(){
 	// CONSTRUCTOR
 	/**
-	 * A base class for all document sources
+	 * A class for grouping documents together
+	 * 
+	 * @class GroupDocumentSource
+	 * @namespace munge.pipeline.documentsource
+	 * @module munge
+	 * @constructor
 	 * @param	{ExpressionContext}	
 	**/
 	var klass = module.exports = GroupDocumentSource = function GroupDocumentSource(groupElement){

+ 1 - 1
lib/pipeline/documentSources/LimitDocumentSource.js

@@ -4,7 +4,7 @@ var LimitDocumentSource = module.exports = (function(){
 	 * A document source limiter
 	 * 
 	 * @class LimitDocumentSource
-	 * @namespace munge.pipepline.documentsource
+	 * @namespace munge.pipeline.documentsource
 	 * @module munge
 	 * @constructor
 	 * @param {Object} query the match query to use

+ 1 - 1
lib/pipeline/documentSources/MatchDocumentSource.js

@@ -5,7 +5,7 @@ var MatchDocumentSource = module.exports = (function(){
 	 * Currently uses sift to fake it
 	 * 
 	 * @class MatchDocumentSource
-	 * @namespace munge.pipepline.documentsource
+	 * @namespace munge.pipeline.documentsource
 	 * @module munge
 	 * @constructor
 	 * @param {Object} query the match query to use

+ 1 - 1
lib/pipeline/documentSources/ProjectDocumentSource.js

@@ -4,7 +4,7 @@ var ProjectDocumentSource = module.exports = (function(){
 	 * A base class for filter document sources
 	 * 
 	 * @class ProjectDocumentSource
-	 * @namespace munge.pipepline.documentsource
+	 * @namespace munge.pipeline.documentsource
 	 * @module munge
 	 * @constructor
 	 * @param	{ExpressionContext}	

+ 1 - 1
lib/pipeline/documentSources/SkipDocumentSource.js

@@ -4,7 +4,7 @@ var SkipDocumentSource = module.exports = (function(){
 	 * A document source skipper
 	 * 
 	 * @class SkipDocumentSource
-	 * @namespace munge.pipepline.documentsource
+	 * @namespace munge.pipeline.documentsource
 	 * @module munge
 	 * @constructor
 	 * @param {Object} query the match query to use

+ 1 - 1
lib/pipeline/documentSources/SortDocumentSource.js

@@ -6,7 +6,7 @@ var SortDocumentSource = module.exports = (function(){
 	 * Since we don't have shards, this inherits from DocumentSource, instead of SplittableDocumentSource
 	 * 
 	 * @class SortDocumentSource
-	 * @namespace munge.pipepline.documentsource
+	 * @namespace munge.pipeline.documentsource
 	 * @module munge
 	 * @constructor
 	**/

+ 1 - 1
lib/pipeline/documentSources/UnwindDocumentSource.js

@@ -4,7 +4,7 @@ var UnwindDocumentSource = module.exports = (function(){
 	 * A document source unwindper
 	 * 
 	 * @class UnwindDocumentSource
-	 * @namespace munge.pipepline.documentsource
+	 * @namespace munge.pipeline.documentsource
 	 * @module munge
 	 * @constructor
 	 * @param {Object} query the match query to use

+ 8 - 1
lib/pipeline/expressions/AddExpression.js

@@ -1,6 +1,13 @@
 var AddExpression = module.exports = (function(){
 	// CONSTRUCTOR
-	/** Create an expression that finds the sum of n operands. **/
+	/** 
+	 * Create an expression that finds the sum of n operands. 
+	 *
+	 * @class AddExpression
+	 * @namespace munge.pipeline.expressions
+	 * @module munge
+	 * @constructor
+	**/
 	var klass = module.exports = function AddExpression(){
 		if(arguments.length !== 0) throw new Error("zero args expected");
 		base.call(this);

+ 10 - 4
lib/pipeline/expressions/AndExpression.js

@@ -1,9 +1,15 @@
 var AndExpression = module.exports = (function(){
 	// CONSTRUCTOR
-	/** Create an expression that finds the conjunction of n operands. The
-	| conjunction uses short-circuit logic; the expressions are evaluated in the
-	| order they were added to the conjunction, and the evaluation stops and
-	| returns false on the first operand that evaluates to false.
+	/** 
+	 * Create an expression that finds the conjunction of n operands. The
+	 * conjunction uses short-circuit logic; the expressions are evaluated in the
+	 * order they were added to the conjunction, and the evaluation stops and
+	 * returns false on the first operand that evaluates to false.
+	 *
+	 * @class AndExpression
+	 * @namespace munge.pipeline.expressions
+	 * @module munge
+	 * @constructor
 	**/
 	var klass = module.exports = function AndExpression(){
 		if(arguments.length !== 0) throw new Error("zero args expected");

+ 8 - 1
lib/pipeline/expressions/CoerceToBoolExpression.js

@@ -1,6 +1,13 @@
 var CoerceToBoolExpression = module.exports = (function(){
 	// CONSTRUCTOR
-	/** internal expression for coercing things to booleans **/
+	/** 
+	 * internal expression for coercing things to booleans 
+	 *
+	 * @class CoerceToBoolExpression
+	 * @namespace munge.pipeline.expressions
+	 * @module munge
+	 * @constructor
+	**/
 	var klass = module.exports = function CoerceToBoolExpression(expression){
 		if(arguments.length !== 1) throw new Error("args expected: expression");
 		this.expression = expression;

+ 8 - 1
lib/pipeline/expressions/CompareExpression.js

@@ -1,6 +1,13 @@
 var CompareExpression = module.exports = (function(){
 	// CONSTRUCTOR
-	/** Generic comparison expression that gets used for $eq, $ne, $lt, $lte, $gt, $gte, and $cmp. **/
+	/**
+	 * Generic comparison expression that gets used for $eq, $ne, $lt, $lte, $gt, $gte, and $cmp. 
+	 *
+	 * @class CompareExpression
+	 * @namespace munge.pipeline.expressions
+	 * @module munge
+	 * @constructor
+	**/
 	var klass = module.exports = CompareExpression = function CompareExpression(cmpOp) {
 		if(arguments.length !== 1) throw new Error("args expected: cmpOp");
 		this.cmpOp = cmpOp;

+ 8 - 3
lib/pipeline/expressions/CondExpression.js

@@ -1,9 +1,14 @@
 var CondExpression = module.exports = (function(){
 	// CONSTRUCTOR
 	/**
-	* $cond expression; 
-	*
-	* @see evaluate 
+	 * $cond expression; 
+	 *
+	 * @see evaluate 
+	 *
+	 * @class AndExpression
+	 * @namespace munge.pipeline.expressions
+	 * @module munge
+	 * @constructor
 	**/
 	var klass = module.exports = function CondExpression(){
 		if(arguments.length !== 0) throw new Error("zero args expected");

+ 8 - 1
lib/pipeline/expressions/ConstantExpression.js

@@ -1,6 +1,13 @@
 var ConstantExpression = module.exports = (function(){
 	// CONSTRUCTOR
-	/** Internal expression for constant values **/
+	/** 
+	 * Internal expression for constant values 
+	 *
+	 * @class ConstantExpression
+	 * @namespace munge.pipeline.expressions
+	 * @module munge
+	 * @constructor
+	**/
 	var klass = function ConstantExpression(value){
 		if(arguments.length !== 1) throw new Error("args expected: value");
 		this.value = value;	//TODO: actually make read-only in terms of JS?

+ 8 - 0
lib/pipeline/expressions/DayOfMonthExpression.js

@@ -1,5 +1,13 @@
 var DayOfMonthExpression = module.exports = (function(){
 	// CONSTRUCTOR
+	/**
+	 * Get the DayOfMonth from a date.
+	 *
+	 * @class DayOfMonthExpression
+	 * @namespace munge.pipeline.expressions
+	 * @module munge
+	 * @constructor
+	**/
 	var klass = function DayOfMonthExpression(){
 		if (arguments.length !== 0) throw new Error("zero args expected");
 		base.call(this);

+ 8 - 0
lib/pipeline/expressions/DayOfWeekExpression.js

@@ -1,5 +1,13 @@
 var DayOfWeekExpression = module.exports = (function(){
 	// CONSTRUCTOR
+	/**
+	 * Get the DayOfWeek from a date.
+	 *
+	 * @class DayOfWeekExpression
+	 * @namespace munge.pipeline.expressions
+	 * @module munge
+	 * @constructor
+	**/
 	var klass = function DayOfWeekExpression(){
 		if(arguments.length !== 0) throw new Error("zero args expected");
 		base.call(this);

+ 8 - 0
lib/pipeline/expressions/DayOfYearExpression.js

@@ -1,5 +1,13 @@
 var DayOfYearExpression = module.exports = (function(){
 	// CONSTRUCTOR
+	/**
+	 * Get the DayOfYear from a date.
+	 *
+	 * @class DayOfYearExpression
+	 * @namespace munge.pipeline.expressions
+	 * @module munge
+	 * @constructor
+	**/
 	var klass = function DayOfYearExpression(){
 		if(arguments.length !== 0) throw new Error("zero args expected");
 		base.call(this);

+ 9 - 1
lib/pipeline/expressions/DivideExpression.js

@@ -1,6 +1,14 @@
 var DivideExpression = module.exports = (function(){
 	// CONSTRUCTOR
-	/** A $divide pipeline expression. @see evaluate **/
+	/** 
+	 * A $divide pipeline expression. 
+	 *
+	 * @see evaluate 
+	 * @class DivideExpression
+	 * @namespace munge.pipeline.expressions
+	 * @module munge
+	 * @constructor
+	**/
 	var klass = function DivideExpression(){
 		if(arguments.length !== 0) throw new Error("zero args expected");
 		base.call(this);

+ 5 - 0
lib/pipeline/expressions/FieldRangeExpression.js

@@ -14,6 +14,11 @@ var FieldRangeExpression = module.exports = (function(){
 	*
 	* Note that NE and CMP are not supported.
 	*
+	* @class FieldRangeExpression
+	* @namespace munge.pipeline.expressions
+	* @module munge
+	* @extends munge.pipeline.expressions.Expression
+	* @constructor
 	* @param pathExpr the field path for extracting the field value
 	* @param cmpOp the comparison operator
 	* @param value the value to compare against

+ 9 - 1
lib/pipeline/expressions/HourExpression.js

@@ -1,6 +1,14 @@
 var HourExpression = module.exports = (function(){
 	// CONSTRUCTOR
-	/** An $hour pipeline expression. @see evaluate **/
+	/** 
+	 * An $hour pipeline expression. 
+	 *
+	 * @see evaluate 
+	 * @class HourExpression
+	 * @namespace munge.pipeline.expressions
+	 * @module munge
+	 * @constructor
+	**/
 	var klass = function HourExpression(){
 		if(arguments.length !== 0) throw new Error("zero args expected");
 		base.call(this);

+ 8 - 2
lib/pipeline/expressions/IfNullExpression.js

@@ -1,7 +1,13 @@
 var IfNullExpression = module.exports = (function(){
 	// CONSTRUCTOR
 	/** 
-	* An $ifNull pipeline expression. @see evaluate 
+	 * An $ifNull pipeline expression. 
+	 *
+	 * @see evaluate 
+	 * @class IfNullExpression
+	 * @namespace munge.pipeline.expressions
+	 * @module munge
+	 * @constructor
 	**/
 	var klass = function IfNullExpression(){
 		if(arguments.length !== 0) throw new Error("zero args expected");
@@ -30,4 +36,4 @@ var IfNullExpression = module.exports = (function(){
 	};
 
 	return klass;
-})();
+})();

+ 9 - 1
lib/pipeline/expressions/MinuteExpression.js

@@ -1,6 +1,14 @@
 var MinuteExpression = module.exports = (function(){
 	// CONSTRUCTOR
-	/** A $minute pipeline expression. @see evaluate **/
+	/** 
+	 * An $minute pipeline expression. 
+	 *
+	 * @see evaluate 
+	 * @class MinuteExpression
+	 * @namespace munge.pipeline.expressions
+	 * @module munge
+	 * @constructor
+	**/
 	var klass = function MinuteExpression(){
 		if(arguments.length !== 0) throw new Error("zero args expected");
 		base.call(this);

+ 9 - 1
lib/pipeline/expressions/ModExpression.js

@@ -1,6 +1,14 @@
 var ModExpression = module.exports = (function(){
 	// CONSTRUCTOR
-	/** A $mod pipeline expression. @see evaluate **/
+	/** 
+	 * An $Mod pipeline expression. 
+	 *
+	 * @see evaluate 
+	 * @class ModExpression
+	 * @namespace munge.pipeline.expressions
+	 * @module munge
+	 * @constructor
+	**/
 	var klass = function ModExpression(){
 		if(arguments.length !== 0) throw new Error("zero args expected");
 		base.call(this);

+ 9 - 1
lib/pipeline/expressions/MonthExpression.js

@@ -1,6 +1,14 @@
 var MonthExpression = module.exports = (function(){
 	// CONSTRUCTOR
-	/** A $month pipeline expression. @see evaluate **/
+	/** 
+	 * An $Month pipeline expression. 
+	 *
+	 * @see evaluate 
+	 * @class MonthExpression
+	 * @namespace munge.pipeline.expressions
+	 * @module munge
+	 * @constructor
+	**/
 	var klass = function MonthExpression(){
 		if(arguments.length !== 0) throw new Error("zero args expected");
 		base.call(this);

+ 9 - 1
lib/pipeline/expressions/MultiplyExpression.js

@@ -1,6 +1,14 @@
 var MultiplyExpression = module.exports = (function(){
 	// CONSTRUCTOR
-	/** A $multiply pipeline expression. @see evaluate **/
+	/** 
+	 * An $Multiply pipeline expression. 
+	 *
+	 * @see evaluate 
+	 * @class MultiplyExpression
+	 * @namespace munge.pipeline.expressions
+	 * @module munge
+	 * @constructor
+	**/
 	var klass = function MultiplyExpression(){
 		if(arguments.length !== 0) throw new Error("zero args expected");
 		base.call(this);

+ 4 - 0
lib/pipeline/expressions/NotExpression.js

@@ -4,6 +4,10 @@ var NotExpression = module.exports = (function(){
 	* An $not pipeline expression. 
 	*
 	* @see evaluate 
+	 * @class NotExpression
+	 * @namespace munge.pipeline.expressions
+	 * @module munge
+	 * @constructor
 	**/
 	var klass = function NotExpression(){
 		if(arguments.length !== 0) throw new Error("zero args expected");

+ 7 - 3
lib/pipeline/expressions/OrExpression.js

@@ -1,9 +1,13 @@
 var OrExpression = module.exports = (function(){
 	// CONSTRUCTOR
 	/** 
-	* An $or pipeline expression. 
-	*
-	* @see evaluate 
+	 * An $or pipeline expression. 
+	 *
+	 * @see evaluate 
+	 * @class OrExpression
+	 * @namespace munge.pipeline.expressions
+	 * @module munge
+	 * @constructor
 	**/
 	var klass = function OrExpression(){
 		if(arguments.length !== 0) throw new Error("zero args expected");

+ 9 - 1
lib/pipeline/expressions/SecondExpression.js

@@ -1,6 +1,14 @@
 var SecondExpression = module.exports = (function(){
 	// CONSTRUCTOR
-	/** A $second pipeline expression. @see evaluate **/
+	/** 
+	 * An $second pipeline expression. 
+	 *
+	 * @see evaluate 
+	 * @class SecondExpression
+	 * @namespace munge.pipeline.expressions
+	 * @module munge
+	 * @constructor
+	**/
 	var klass = function SecondExpression(){
 		if(arguments.length !== 0) throw new Error("zero args expected");
 		base.call(this);

+ 7 - 1
lib/pipeline/expressions/StrcasecmpExpression.js

@@ -1,7 +1,13 @@
 var StrcasecmpExpression = module.exports = (function(){
 	// CONSTRUCTOR
 	/** 
-	* A $strcasecmp pipeline expression. @see evaluate 
+	 * A $strcasecmp pipeline expression.
+	 *
+	 * @see evaluate 
+	 * @class StrcasecmpExpression
+	 * @namespace munge.pipeline.expressions
+	 * @module munge
+	 * @constructor
 	**/
 	var klass = function StrcasecmpExpression(){
 		if(arguments.length !== 0) throw new Error("zero args expected");

+ 7 - 1
lib/pipeline/expressions/SubstrExpression.js

@@ -1,7 +1,13 @@
 var SubstrExpression = module.exports = (function(){
 	// CONSTRUCTOR
 	/**
-	* A $substr pipeline expression. @see evaluate
+	 * A $substr pipeline expression.
+	 *
+	 * @see evaluate 
+	 * @class SubstrExpression
+	 * @namespace munge.pipeline.expressions
+	 * @module munge
+	 * @constructor
 	**/
 	var klass = function SubstrExpression(){
 		if(arguments.length !== 0) throw new Error("zero args expected");

+ 7 - 1
lib/pipeline/expressions/SubtractExpression.js

@@ -1,7 +1,13 @@
 var SubtractExpression = module.exports = (function(){
 	// CONSTRUCTOR
 	/** 
-	* A $subtract pipeline expression. @see evaluate 
+	 * A $subtract pipeline expression.
+	 *
+	 * @see evaluate 
+	 * @class SubtractExpression
+	 * @namespace munge.pipeline.expressions
+	 * @module munge
+	 * @constructor
 	**/
 	var klass = function SubtractExpression(){
 		if(arguments.length !== 0) throw new Error("zero args expected");

+ 7 - 1
lib/pipeline/expressions/ToLowerExpression.js

@@ -1,7 +1,13 @@
 var ToLowerExpression = module.exports = (function(){
 	// CONSTRUCTOR
 	/** 
-	* A $toLower pipeline expression. @see evaluate 
+	 * A $toLower pipeline expression.
+	 *
+	 * @see evaluate 
+	 * @class ToLowerExpression
+	 * @namespace munge.pipeline.expressions
+	 * @module munge
+	 * @constructor
 	**/
 	var klass = function ToLowerExpression(){
 		if(arguments.length !== 0) throw new Error("zero args expected");

+ 7 - 1
lib/pipeline/expressions/ToUpperExpression.js

@@ -1,7 +1,13 @@
 var ToUpperExpression = module.exports = (function(){
 	// CONSTRUCTOR
 	/** 
-	* A $toUpper pipeline expression. @see evaluate 
+	 * A $toUpper pipeline expression.
+	 *
+	 * @see evaluate 
+	 * @class ToUpperExpression
+	 * @namespace munge.pipeline.expressions
+	 * @module munge
+	 * @constructor
 	**/
 	var klass = function ToUpperExpression(){
 		if(arguments.length !== 0) throw new Error("zero args expected");

+ 9 - 1
lib/pipeline/expressions/WeekExpression.js

@@ -1,6 +1,14 @@
 var WeekExpression = module.exports = (function(){
 	// CONSTRUCTOR
-	/** A $week pipeline expression. @see evaluate **/
+	/** 
+	 * A $week pipeline expression.
+	 *
+	 * @see evaluate 
+	 * @class WeekExpression
+	 * @namespace munge.pipeline.expressions
+	 * @module munge
+	 * @constructor
+	**/
 	var klass = function WeekExpression(){
 		if(arguments.length !== 0) throw new Error("zero args expected");
 		base.call(this);

+ 9 - 1
lib/pipeline/expressions/YearExpression.js

@@ -1,6 +1,14 @@
 var YearExpression = module.exports = (function(){
 	// CONSTRUCTOR
-	/** A $year pipeline expression. @see evaluate **/
+	/** 
+	 * A $year pipeline expression.
+	 *
+	 * @see evaluate 
+	 * @class YearExpression
+	 * @namespace munge.pipeline.expressions
+	 * @module munge
+	 * @constructor
+	**/
 	var klass = function YearExpression(){
 		if(arguments.length !== 0) throw new Error("zero args expected");
 		base.call(this);