Enlightenment CVS committal

Author  : raster
Project : e17
Module  : libs/ecore

Dir     : e17/libs/ecore/src/lib/ecore_job


Modified Files:
      Tag: SPLIT
        Ecore_Job.h ecore_job.c 


Log Message:


doc doc doc... :)
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ecore/src/lib/ecore_job/Attic/Ecore_Job.h,v
retrieving revision 1.1.2.1
retrieving revision 1.1.2.2
diff -u -3 -r1.1.2.1 -r1.1.2.2
--- Ecore_Job.h 16 Jan 2003 10:30:30 -0000      1.1.2.1
+++ Ecore_Job.h 20 Feb 2003 06:56:40 -0000      1.1.2.2
@@ -6,7 +6,7 @@
 #endif
    
 #ifndef _ECORE_JOB_PRIVATE_H
-typedef void Ecore_Job;
+typedef void Ecore_Job; /**< A job handle */
 #endif
 
 Ecore_Job *ecore_job_add(void (*func) (void *data), const void *data);    
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ecore/src/lib/ecore_job/Attic/ecore_job.c,v
retrieving revision 1.1.2.3
retrieving revision 1.1.2.4
diff -u -3 -r1.1.2.3 -r1.1.2.4
--- ecore_job.c 12 Feb 2003 11:27:32 -0000      1.1.2.3
+++ ecore_job.c 20 Feb 2003 06:56:40 -0000      1.1.2.4
@@ -10,14 +10,14 @@
 
 /**
  * Add a job to the event queue
- * @param func
- * @param data
+ * @param func The function to be called when the job gets handled
+ * @param data The data to be passed to the job function
  * @return A job handle
  * 
  * Add a job to the queue to be executed by the event system later on and
- * return a pointer to the job handle. When the job is to be executed, the function 
@p func is
- * called and passed the pointer @p data. once the job has been executed the
- * job handle is no longer valid.
+ * return a pointer to the job handle. When the job is to be executed, the 
+ * function @p func is called and passed the pointer @p data. once the job has
+ * been executed the job handle is no longer valid.
  */
 Ecore_Job *
 ecore_job_add(void (*func) (void *data), const void *data)
@@ -46,7 +46,7 @@
 
 /**
  * Delete a queued job
- * @param job
+ * @param job The job to delete
  * @return The data pointer to be passed to the job
  * 
  * This removed a job from the queue (if it hasn't been executed yet) and




-------------------------------------------------------
This SF.net email is sponsored by: SlickEdit Inc. Develop an edge.
The most comprehensive and flexible code editor you can use.
Code faster. C/C++, C#, Java, HTML, XML, many more. FREE 30-Day Trial.
www.slickedit.com/sourceforge
_______________________________________________
enlightenment-cvs mailing list
[EMAIL PROTECTED]
https://lists.sourceforge.net/lists/listinfo/enlightenment-cvs

Reply via email to