Document Strategy class.

jaredhanson · Oct 14, 2011 · a6889bf · a6889bf
1 parent c933f8e
commit a6889bf
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/lib/passport/strategy.js b/lib/passport/strategy.js
@@ -13,6 +13,15 @@ function Strategy() {
   this.middleware = [];
 }
 
+/**
+ * Authenticate request.
+ *
+ * This function must be overridden by subclasses.  In abstract form, it always
+ * throws an exception.
+ *
+ * @param {Object} req
+ * @api protected
+ */
 Strategy.prototype.authenticate = function(req) {
   throw new Error('Strategy#authenticate must be overridden by subclass');
 }