Enlightenment CVS committal

Author  : atmosphere
Project : e17
Module  : apps/entrance

Dir     : e17/apps/entrance/src/client


Modified Files:
        entrance_user.c entrance_config.c 


Log Message:
more docs
===================================================================
RCS file: /cvsroot/enlightenment/e17/apps/entrance/src/client/entrance_user.c,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -3 -r1.1 -r1.2
--- entrance_user.c     3 Mar 2004 15:09:34 -0000       1.1
+++ entrance_user.c     3 Mar 2004 16:13:10 -0000       1.2
@@ -16,6 +16,16 @@
 extern void user_unselected_cb(void *data, Evas_Object * o,
                                const char *emission, const char *source);
 
+/**
+ * entrance_user_new - given a user, icon, and session, create a new
+ * Entrance_User instance.  We don't copy the pointers here, simply use
+ * them, it allows for us to pass in NULL, and easily use edb supplied data
+ * w/o having to free it.
+ * @user - the user's user id on the system
+ * @icon - the user's "face" icon, an edje or eet
+ * @session - the key into the session hash that this user considers their
+ * "default"
+ */
 Entrance_User *
 entrance_user_new(char *user, char *icon, char *session)
 {
@@ -31,6 +41,12 @@
    return (e);
 }
 
+/**
+ * entrance_user_auto_login_set : allow this user to auto login, currently
+ * not used
+ * @e - the Entrance_User the request is for
+ * @allow - true(1) to allow, false(0) to disallow
+ */
 void
 entrance_user_auto_login_set(Entrance_User * e, int allow)
 {
@@ -38,6 +54,10 @@
       e->autologin = allow;
 }
 
+/**
+ * entrance_user_free: free this Entrance_User
+ * @e - the Entrance_User to free
+ */
 void
 entrance_user_free(Entrance_User * e)
 {
@@ -51,6 +71,13 @@
    }
 }
 
+/**
+ * entrance_user_edje_get : get the Evas_Object(edje||image) that is
+ * specified in config db.  Their "EntranceFace"
+ * @e - the Entrance_User to get the edje for
+ * @edje - a pointer to the main edje in entrance
+ * Returns NULL on failure, a valid Evas_Object on success
+ */
 Evas_Object *
 entrance_user_edje_get(Entrance_User * e, Evas_Object * edje)
 {
@@ -103,6 +130,13 @@
    return (o);
 }
 
+/**
+ * _entrance_user_icon_load : It says this is the filename, gimme an evas
+ * object for it, I don't care what type. :)
+ * @o - another object in the Canvas
+ * @file - the filename on disk, might be an edje, might be an image
+ * Returns - NULL on failure, a valid Evas_Object on success
+ */
 static Evas_Object *
 _entrance_user_icon_load(Evas_Object * o, char *file)
 {
===================================================================
RCS file: /cvsroot/enlightenment/e17/apps/entrance/src/client/entrance_config.c,v
retrieving revision 1.15
retrieving revision 1.16
diff -u -3 -r1.15 -r1.16
--- entrance_config.c   3 Mar 2004 15:09:03 -0000       1.15
+++ entrance_config.c   3 Mar 2004 16:13:10 -0000       1.16
@@ -132,6 +132,10 @@
          e->sessions.keys = evas_list_append(e->sessions.keys, key);
       }
    }
+   /* 
+    * FIXME: With embedded fonts in your edjes, do we even wanna bother with
+    * the font path nightmare anymore ?  Unless we use etox or something ...
+    */
    if (e_db_int_get(db, "/entrance/fonts/count", &num_fonts))
    {
       char *value = NULL;
@@ -252,7 +256,12 @@
 }
 
 /**
- *
+ * entrance_config_user_list_write : Write out the possibly reordered user
+ * list into the config db.  This still needs fixing.
+ * FIXME: Nuke all old keys from the db relating to /entrance/user
+ * FIXME: Check another config parameter whether we should write or not
+ * FIXME: Check another config parameter so we only write n user
+ * @e - a pointer to the config struct we want to write the user list for
  */
 void
 entrance_config_user_list_write(Entrance_Config * e)




-------------------------------------------------------
SF.Net is sponsored by: Speed Start Your Linux Apps Now.
Build and deploy apps & Web services for Linux with
a free DVD software kit from IBM. Click Now!
http://ads.osdn.com/?ad_id=1356&alloc_id=3438&op=click
_______________________________________________
enlightenment-cvs mailing list
[EMAIL PROTECTED]
https://lists.sourceforge.net/lists/listinfo/enlightenment-cvs

Reply via email to