matcher comment

moonwatcher · May 2, 2011 · 216f9ca · 216f9ca
1 parent ddd7dd3
commit 216f9ca
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/db/matcher.h b/db/matcher.h
@@ -232,6 +232,10 @@ namespace mongo {
         bool matchesWithSingleKeyIndex(const BSONObj &key, const DiskLoc &recLoc , MatchDetails * details = 0 ) {
             return matches( key, recLoc, details, true );   
         }
+        /**
+         * This is the preferred method for matching against a cursor, as it
+         * can handle both multi and single key cursors.
+         */
         bool matchesCurrent( Cursor * cursor , MatchDetails * details = 0 );
         bool needRecord() { return _needRecord; }