changeset 17505:69e0551deebe

- Added a description of preference grouping to the Prefs API code
author William Ehlhardt <williamehlhardt@gmail.com>
date Wed, 30 May 2007 23:39:44 +0000
parents 4c1f8041e573
children fa33879e3a0a
files libpurple/prefs.h
diffstat 1 files changed, 3 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/libpurple/prefs.h	Wed May 30 03:55:56 2007 +0000
+++ b/libpurple/prefs.h	Wed May 30 23:39:44 2007 +0000
@@ -55,7 +55,9 @@
 #endif
 
 /**************************************************************************/
-/** @name Prefs API                                                       */
+/** @name Prefs API                                                       
+    Preferences are named according to a directory-like structure.        
+    Example: "/plugins/core/potato/is_from_idaho" (probably a boolean)    */
 /**************************************************************************/
 /*@{*/