From 39fd9b55d72db067937de725efdc946b2b31f1b2 Mon Sep 17 00:00:00 2001 From: Dan Stillman Date: Mon, 1 Dec 2008 08:33:07 +0000 Subject: [PATCH] Updated comments --- chrome/content/zotero/xpcom/data/item.js | 10 ++++++---- chrome/content/zotero/xpcom/data/items.js | 9 +++++---- 2 files changed, 11 insertions(+), 8 deletions(-) diff --git a/chrome/content/zotero/xpcom/data/item.js b/chrome/content/zotero/xpcom/data/item.js index b56e361f81..d85bd7229b 100644 --- a/chrome/content/zotero/xpcom/data/item.js +++ b/chrome/content/zotero/xpcom/data/item.js @@ -3071,10 +3071,12 @@ Zotero.Item.prototype.clone = function(includePrimary) { /** -* Delete item from database and clear from Zotero.Items internal array -* -* Items.erase() should be used instead of this -**/ + * Delete item from database and clear from Zotero.Items internal array + * + * Items.erase() should be used instead of this + * + * @param {Boolean} eraseChildren Erase child items as well + */ Zotero.Item.prototype.erase = function(deleteChildren) { if (!this.id) { return false; diff --git a/chrome/content/zotero/xpcom/data/items.js b/chrome/content/zotero/xpcom/data/items.js index e332a44ba7..3d23a8ded3 100644 --- a/chrome/content/zotero/xpcom/data/items.js +++ b/chrome/content/zotero/xpcom/data/items.js @@ -321,10 +321,11 @@ Zotero.Items = new function() { /** - * Delete item(s) from database and clear from internal array - * - * If _eraseChildren_ is true, erase child items as well - **/ + * Delete item(s) from database and clear from internal array + * + * @param {Integer|Integer[]} ids Item ids + * @param {Boolean} eraseChildren Erase child items as well + */ function erase(ids, eraseChildren) { ids = Zotero.flattenArguments(ids);