From 456e141fb3fc9fe2ab4bbf3b656bae21934e6835 Mon Sep 17 00:00:00 2001
From: "bnesse%netscape.com"
 <bnesse%netscape.com@18797224-902f-48f8-a5cc-f745e15eee43>
Date: Wed, 18 Apr 2001 05:16:47 +0000
Subject: [PATCH] Added comments as per alecf. [Not part of the build.]

git-svn-id: svn://10.0.0.236/trunk@92660 18797224-902f-48f8-a5cc-f745e15eee43
---
 .../modules/libpref/public/nsIPrefService.idl | 31 ++++++++++++++++++-
 1 file changed, 30 insertions(+), 1 deletion(-)

diff --git a/mozilla/modules/libpref/public/nsIPrefService.idl b/mozilla/modules/libpref/public/nsIPrefService.idl
index 0d7a54fff1c..6e29436010d 100644
--- a/mozilla/modules/libpref/public/nsIPrefService.idl
+++ b/mozilla/modules/libpref/public/nsIPrefService.idl
@@ -53,7 +53,8 @@ interface nsIPrefService : nsISupports
   /*
    * resetUserPrefs
    * 
-   * flush all current user prefrences (reset all preferences to the default values)
+   * flush all current user prefrences (reset all preferences to the default
+   * values)
    */
   void resetUserPrefs();
 
@@ -64,11 +65,39 @@ interface nsIPrefService : nsISupports
    */
   void savePrefFile(in nsIFile aFile);
 
+
   /*
    * branch operations
+   * 
+   * These methods return a Preferences "Branch" from which preference data
+   * may be accessed or manipulated. For example, if "browser.startup." is
+   * passed in as the branch root, the branch will be able to access the
+   * preferences "browser.startup.homepage",
+   * "browser.startup.homepage_override", and "browser.startup.page".
+   * 
+   * pass in null or "" to have access to all preferences.
    */
 
+  /*
+   * getBranch
+   * 
+   * returns a Preferences "Branch" which accesses user preference data. If
+   * no user preference has been set, the default value will be returned.
+   * 
+   * When using a Set function, this will always create or set a user
+   * preference.
+   */
   nsIPrefBranch getBranch(in string aPrefRoot);
+
+  /*
+   * getDefaultBranch
+   * 
+   * returns a Preferences "Branch" which accesses the default preference
+   * data directly.
+   * 
+   * When using a Set function, this will always create or set a default
+   * preference.
+   */
   nsIPrefBranch getDefaultBranch(in string aPrefRoot);
 
 };