Enlightenment CVS committal
Author : atmosphere
Project : e17
Module : apps/entrance
Dir : e17/apps/entrance/src/client
Modified Files:
entrance_auth.c entrance_session.c entrance_user.c main.c
util.c
Log Message:
doxygen friendly
===================================================================
RCS file: /cvsroot/enlightenment/e17/apps/entrance/src/client/entrance_auth.c,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -3 -r1.11 -r1.12
--- entrance_auth.c 2 Jan 2004 18:19:31 -0000 1.11
+++ entrance_auth.c 3 Mar 2004 17:34:26 -0000 1.12
@@ -63,7 +63,7 @@
/**
* entrance_auth_new
- * Returns a 0'd out Entrance_Auth Struct
+ * @return a 0'd out Entrance_Auth Struct
*/
Entrance_Auth *
entrance_auth_new(void)
@@ -183,7 +183,7 @@
/**
* entrance_auth_cmp_pam - attempt to auth the user
* @e The Entrance_Auth struct to attempt to validate on the system
- * Returns - 0 on success, 1 on error
+ * @return - 0 on success, 1 on error
*/
int
entrance_auth_cmp_pam(Entrance_Auth * e)
@@ -271,7 +271,7 @@
* entrance_auth_set_user - set the username in the struct
* @e - the Entrance_Auth to set the user of
* @str - a string to set the user to, NULL is fine
- * Returns - 0 on success, 1 on failure(User not in system)
+ * @return 0 on success, 1 on failure(User not in system)
* Check to see if the user exists on the system, if they do, e->user is set
* to the passed in string, if they don't, e->user is unmodified.
*/
===================================================================
RCS file: /cvsroot/enlightenment/e17/apps/entrance/src/client/entrance_session.c,v
retrieving revision 1.33
retrieving revision 1.34
diff -u -3 -r1.33 -r1.34
--- entrance_session.c 3 Mar 2004 15:55:39 -0000 1.33
+++ entrance_session.c 3 Mar 2004 17:34:26 -0000 1.34
@@ -9,7 +9,7 @@
/**
@file entrance_session.c
[EMAIL PROTECTED] Variables and Data relating to an instance of the interface
[EMAIL PROTECTED] Variables and Data relating to an instance of the application as a
whole
*/
@@ -32,7 +32,8 @@
/**
* entrance_session_new: allocate a new Entrance_Session
- * Returns a valid Entrance_Session
+ * @param config - parse this config file instead of the normal system one
+ * @return a valid Entrance_Session
* Also Allocates the auth, and parse the config struct
*/
Entrance_Session *
@@ -66,8 +67,8 @@
/**
* entrance_session_free: free the entrance session
- * @e - the Entrance_Session to set the ecore evas for
- * @ee - the pointer to a fully setup Ecore_Evas we want to run
+ * @param e - the Entrance_Session to set the ecore evas for
+ * @param ee - the pointer to a fully setup Ecore_Evas we want to run
*/
void
entrance_session_ecore_evas_set(Entrance_Session * e, Ecore_Evas * ee)
@@ -94,7 +95,7 @@
/**
* entrance_session_free: free the entrance session
- * @e - the Entrance_Session to free
+ * @param e - the Entrance_Session to free
*/
void
entrance_session_free(Entrance_Session * e)
@@ -118,7 +119,7 @@
/**
* entrance_session_run: Be a login dm, start running
- * @e - the Entrance_Session to be run
+ * @param e - the Entrance_Session to be run
*/
void
entrance_session_run(Entrance_Session * e)
@@ -129,8 +130,8 @@
/**
* entrance_session_auth_user: attempt to authenticate the user
- * @e - the entrance session we're trying to auth
- * Returns 0 on success errors otherwise
+ * @param e - the entrance session we're trying to auth
+ * @return 0 on success errors otherwise
*/
int
entrance_session_auth_user(Entrance_Session * e)
@@ -145,7 +146,7 @@
/**
* entrance_session_user_reset: forget what we know about the current user
- * @e - the entrance session we should forget the user for
+ * @param e - the entrance session we should forget the user for
*/
void
entrance_session_user_reset(Entrance_Session * e)
@@ -165,8 +166,8 @@
* entrance_session_user_set: forget what we know about the current user,
* load what info we can from the entrance user parameter, so we have a new
* user in our "EntranceFace" edje
- * @e - the entrance sesssion currently running
- * @eu - the new entrance user we're setting as "current"
+ * @param e - the entrance sesssion currently running
+ * @param eu - the new entrance user we're setting as "current"
*/
void
entrance_session_user_set(Entrance_Session * e, Entrance_User * eu)
@@ -246,7 +247,7 @@
* context. This only will get written if someone successfully auths after
* a selection like this is made, but it allows themes etc to have dialogs
* deciding whether or not they should save this new session as default
- * @e - the currently running session
+ * @param e - the currently running session
*/
void
entrance_session_user_session_default_set(Entrance_Session * e)
@@ -267,7 +268,7 @@
/**
* entrance_session_start_user_session : If the user is authed, try to log
* their asses in.
- * @e - the currently running session
+ * @param e - the currently running session
*/
void
entrance_session_start_user_session(Entrance_Session * e)
@@ -360,8 +361,8 @@
* entrance_session_xsession_set. It only frees the current EntranceSession
* object in the main edje if loading the newly requested one was
* successful.
- * @e - the entrance session you want to set the session for
- * @key - the key in the config hash that has this session
+ * @param e - the entrance session you want to set the session for
+ * @param key - the key in the config hash that has this session
*/
static void
entrance_session_xsession_load(Entrance_Session * e, const char *key)
@@ -396,8 +397,8 @@
* entrance_session_xsession_set : Set the current xsesssion to the
* specified key, emit a signal to the main edje letting it know the main
* session has changed
- * @e - the entrance session you want to set the session for
- * @key - the key in the config hash that has this session
+ * @param e - the entrance session you want to set the session for
+ * @param key - the key in the config hash that has this session
*/
void
entrance_session_xsession_set(Entrance_Session * e, const char *key)
@@ -426,8 +427,8 @@
/**
* entrance_session_edje_object_set : Set the main edje for the session to
* be the parameter passed in
- * @e - the entrance session you want to modify
- * @o - the new edje you're specifying
+ * @param e - the entrance session you want to modify
+ * @param o - the new edje you're specifying
*/
void
entrance_session_edje_object_set(Entrance_Session * e, Evas_Object * obj)
@@ -443,6 +444,7 @@
* entrance_session_list_add : fine the "EntranceSessionList" part in the
* main edje, setup the container to hold the elements, and create session
* edjes for the container based on our session list in the config
+ * @param e - the entrance session you want to add the xsession list to
*/
void
entrance_session_list_add(Entrance_Session * e)
@@ -489,6 +491,7 @@
* entrance_session_user_list_add : find the "EntranceUserList" object in
* the main edje, setup the container to hold the elements, and create user
* edjes for the container with our user list in the config
+ * @param e - the entrance session you want to add the user list to
*/
void
entrance_session_user_list_add(Entrance_Session * e)
@@ -533,6 +536,7 @@
/**
* entrance_session_default_xsession_get : Return the hash key for the
* session that's the first item in the system's session list
+ * @param e - the entrance session you're working with
*/
const char *
entrance_session_default_xsession_get(Entrance_Session * e)
@@ -556,6 +560,8 @@
* valid edje eet or anything your evas has images loaders for.
* FIXME: Should this be its own smart object, user images are done similar
* FIXME: Should it support a "key" paramater as well
+ * @param e - the entrance session you're working with
+ * @param file - the file in $pkgdatadir/images/sessions/ we want to load
*/
static Evas_Object *
_entrance_session_icon_load(Evas_Object * o, const char *file)
@@ -591,7 +597,10 @@
/**
* _entrance_session_load_session : given the key, try loading an instance
* of the "Session" group from the current theme. printf on failure. :(
- * Returns the new session object, or NULL on failure.
+ * @return the new session object, or NULL on failure.
+ * @param e - the entrance session you're working with
+ * @param key - the key for the EntranceSessionIcon file in the
+ * EntranceSession edje
*/
static Evas_Object *
_entrance_session_load_session(Entrance_Session * e, const char *key)
@@ -663,6 +672,7 @@
* _entrance_session_user_list_fix : update the user's list with the current
* user as the new head of the list. If it's the first time the user has
* logged in, create a new user element and prepend it to the list.
+ * @param e - the entrance session you're working with
*/
static void
_entrance_session_user_list_fix(Entrance_Session * e)
===================================================================
RCS file: /cvsroot/enlightenment/e17/apps/entrance/src/client/entrance_user.c,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -3 -r1.2 -r1.3
--- entrance_user.c 3 Mar 2004 16:13:10 -0000 1.2
+++ entrance_user.c 3 Mar 2004 17:34:26 -0000 1.3
@@ -7,6 +7,12 @@
#include <limits.h>
#include "../config.h"
+/**
[EMAIL PROTECTED] entrance_user.c
[EMAIL PROTECTED] Variables and Data relating to an instance of a user in entrance
+
+*/
+
/**
* protos
*/
@@ -21,9 +27,9 @@
* 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
+ * @param user - the user's user id on the system
+ * @param icon - the user's "face" icon, an edje or eet
+ * @param session - the key into the session hash that this user considers their
* "default"
*/
Entrance_User *
@@ -44,8 +50,8 @@
/**
* 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
+ * @param e - the Entrance_User the request is for
+ * @param allow - true(1) to allow, false(0) to disallow
*/
void
entrance_user_auto_login_set(Entrance_User * e, int allow)
@@ -56,7 +62,7 @@
/**
* entrance_user_free: free this Entrance_User
- * @e - the Entrance_User to free
+ * @param e - the Entrance_User to free
*/
void
entrance_user_free(Entrance_User * e)
@@ -74,9 +80,9 @@
/**
* 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
+ * @param e - the Entrance_User to get the edje for
+ * @para edje - a pointer to the main edje in entrance
+ * @return NULL on failure, a valid Evas_Object on success
*/
Evas_Object *
entrance_user_edje_get(Entrance_User * e, Evas_Object * edje)
@@ -133,9 +139,9 @@
/**
* _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
+ * @param o - another object in the Canvas
+ * @param file - the filename on disk, might be an edje, might be an image
+ * @return 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/main.c,v
retrieving revision 1.35
retrieving revision 1.36
diff -u -3 -r1.35 -r1.36
--- main.c 3 Mar 2004 16:48:20 -0000 1.35
+++ main.c 3 Mar 2004 17:34:26 -0000 1.36
@@ -498,26 +498,27 @@
* main - where it all starts !
* @argc - the number of arguments entrance was called with
* @argv - the args entrance was called with
- * Entrance works like this:
- * 1. Init Ecore
- * 2. Parse command line arguments
- * 3. Create a New Entrance_Session(Parses config for you)
- * 4. Init Ecore_X
- * 5. Init Ecore_Evas
- * 6. Init Edje
- * 7. Detect Ecore_Evas type from config, software or gl
- * 8. Set the cursor specified in the config
- * 9. Add key modifiers, setup caches and paths
- * 10. Load theme specified in config, or from cli(cli overrides config)
- * 11. Swallow the username and password entries into the edje
- * 12. Detect theme part presence, swallow/setup as appropriate
- * 13. Setup signal callbacks that our main edje might emit
- * 14. Show the main edje
- * 15. Emit an "In" signal on the main entry for lazy themers
- * 16. Tell the Entrance_Sesssion that the Ecore_Evas belongs to it
- * 17. Run.............. until ecore_main_loop_quit is called
- * 18. If the user is authenticated, try to run their session
- * 19. Shut down edje, ecore_evas, ecore_x, ecore
+ * <p>Entrance works like this:<ol>
+ * <li> Init Ecore </li>
+ * <li> Parse command line arguments </li>
+ * <li> Create a New Entrance_Session(Parses config for you) </li>
+ * <li> Init Ecore_X </li>
+ * <li> Init Ecore_Evas </li>
+ * <li> Init Edje </li>
+ * <li> Detect Ecore_Evas type from config, software or gl</li>
+ * <li> Set the cursor specified in the config </li>
+ * <li> Add key modifiers, setup caches and paths </li>
+ * <li> Load theme specified in config, or from cli(cli overrides
+ * config)</li>
+ * <li> Swallow the username and password entries into the edje </li>
+ * <li> Detect theme part presence, swallow/setup as appropriate </li>
+ * <li> Setup signal callbacks that our main edje might emit </li>
+ * <li> Show the main edje </li>
+ * <li> Emit an "In" signal on the main entry for lazy themers </li>
+ * <li> Tell the Entrance_Sesssion that the Ecore_Evas belongs to it</li>
+ * <li> Run.............. until ecore_main_loop_quit is called</li>
+ * <li> If the user is authenticated, try to run their session</li>
+ * <li>Shut down edje, ecore_evas, ecore_x, ecore</li>
*/
int
main(int argc, char *argv[])
===================================================================
RCS file: /cvsroot/enlightenment/e17/apps/entrance/src/client/util.c,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -3 -r1.1 -r1.2
--- util.c 31 Jan 2003 21:57:06 -0000 1.1
+++ util.c 3 Mar 2004 17:34:26 -0000 1.2
@@ -1,5 +1,16 @@
#include "util.h"
+/**
[EMAIL PROTECTED] util.c
[EMAIL PROTECTED] Functions that do things that don't quite fit anywhere else
+
+*/
+
+/**
+ * struct_passwd_dup : duplicate a struct passwd *
+ * @param pwent - the struct passwd pointer we want to copy
+ * @return a valid pointer to an allocated struct passwd *
+ */
struct passwd *
struct_passwd_dup(struct passwd *pwent)
{
@@ -27,6 +38,11 @@
return (result);
}
+/**
+ * struct_passwd_free: free a struct passwd *
+ * @param pwent - the struct passwd pointer we want to free
+ * @return NULL
+ */
void *
struct_passwd_free(struct passwd *pwent)
{
@@ -47,6 +63,10 @@
return (NULL);
}
+/**
+ * entrance_debug: print a message if debugging is on
+ * @param msg - the character string you want printed in debug mode
+ */
void
entrance_debug(char *msg)
{
-------------------------------------------------------
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
