Permalink
Browse files

docs

  • Loading branch information...
1 parent a3a2360 commit ab223d54e086d4ff531e62ddab5fc25d541745db @aheckmann aheckmann committed Feb 2, 2012
Showing with 9 additions and 1 deletion.
  1. +9 −1 lib/document.js
View
@@ -607,6 +607,8 @@ Document.prototype.__defineGetter__('modifiedPaths', function () {
* that we want to send to MongoDB on a Document save.
*
* @param {String} path
+ * @returns Boolean
+ * @api public
*/
Document.prototype.isModified = function (path) {
@@ -628,6 +630,8 @@ Document.prototype.isModified = function (path) {
* that we want to send to MongoDB on a Document save.
*
* @param {String} path
+ * @returns Boolean
+ * @api public
*/
Document.prototype.isDirectModified = function (path) {
@@ -638,6 +642,8 @@ Document.prototype.isDirectModified = function (path) {
* Checks if a certain path was initialized
*
* @param {String} path
+ * @returns Boolean
+ * @api public
*/
Document.prototype.isInit = function (path) {
@@ -648,6 +654,7 @@ Document.prototype.isInit = function (path) {
* Checks if a path was selected.
* @param {String} path
* @return Boolean
+ * @api public
*/
Document.prototype.isSelected = function isSelected (path) {
@@ -1015,8 +1022,8 @@ Document.prototype._registerHooks = function _registerHooks () {
/**
* Registers an error
- * TODO: handle multiple
*
+ * @TODO underscore this method
* @param {Error} error
* @api private
*/
@@ -1029,6 +1036,7 @@ Document.prototype.error = function (err) {
/**
* Executes methods queued from the Schema definition
*
+ * @TODO underscore this method
* @api private
*/

0 comments on commit ab223d5

Please sign in to comment.