Bug 655722 - Fix small issues in the PlacesUtils.promiseBookmarksTree documentation string. r=mak
authorThom Chiovoloni <tchiovoloni@mozilla.com>
Tue, 05 Apr 2016 17:30:55 -0700
changeset 331335 63f11876b0b8ed6f49c697e5072da6eaeddbf2e0
parent 331334 bdc6a9d57ec4a4622848235c7356da4d3008f21e
child 331336 7cfb8c8a1ba485734c8b350eda85b649551c89ac
push id6048
push userkmoir@mozilla.com
push dateMon, 06 Jun 2016 19:02:08 +0000
treeherdermozilla-beta@46d72a56c57d [default view] [failures only]
perfherder[talos] [build metrics] [platform microbench] (compared to previous push)
reviewersmak
bugs655722
milestone48.0a1
first release with
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
last release without
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
Bug 655722 - Fix small issues in the PlacesUtils.promiseBookmarksTree documentation string. r=mak MozReview-Commit-ID: 9b266ALWPHj
toolkit/components/places/PlacesUtils.jsm
--- a/toolkit/components/places/PlacesUtils.jsm
+++ b/toolkit/components/places/PlacesUtils.jsm
@@ -1735,25 +1735,26 @@ this.PlacesUtils = {
    *          complete.
    *
    * @return {Promise}
    * @resolves to a JS object that represents either a single item or a
    * bookmarks tree.  Each node in the tree has the following properties set:
    *  - guid (string): the item's GUID (same as aItemGuid for the top item).
    *  - [deprecated] id (number): the item's id. This is only if
    *    aOptions.includeItemIds is set.
-   *  - type (number):  the item's type.  @see PlacesUtils.TYPE_X_*
+   *  - type (string):  the item's type.  @see PlacesUtils.TYPE_X_*
    *  - title (string): the item's title. If it has no title, this property
    *    isn't set.
    *  - dateAdded (number, microseconds from the epoch): the date-added value of
    *    the item.
    *  - lastModified (number, microseconds from the epoch): the last-modified
    *    value of the item.
    *  - annos (see getAnnotationsForItem): the item's annotations.  This is not
    *    set if there are no annotations set for the item).
+   *  - index: the item's index under it's parent.
    *
    * The root object (i.e. the one for aItemGuid) also has the following
    * properties set:
    *  - parentGuid (string): the GUID of the root's parent.  This isn't set if
    *    the root item is the places root.
    *  - itemsCount (number, not enumerable): the number of items, including the
    *    root item itself, which are represented in the resolved object.
    *