Enlightenment CVS committal
Author : pfritz
Project : e17
Module : libs/ecore
Dir : e17/libs/ecore/src/lib/ecore_con
Modified Files:
Ecore_Con.h ecore_con_url.c
Log Message:
add doxy stubs, so that the function names at least appear in the api references
Thanks to mcalamelli
===================================================================
RCS file: /cvs/e/e17/libs/ecore/src/lib/ecore_con/Ecore_Con.h,v
retrieving revision 1.34
retrieving revision 1.35
diff -u -3 -r1.34 -r1.35
--- Ecore_Con.h 8 Jan 2008 21:28:51 -0000 1.34
+++ Ecore_Con.h 11 Feb 2008 23:24:11 -0000 1.35
@@ -58,6 +58,7 @@
* @li @ref Ecore_Con_Lib_Group
* @li @ref Ecore_Con_Server_Group
* @li @ref Ecore_Con_Client_Group
+ * @li @ref Ecore_Con_Url_Group
*/
#ifdef __cplusplus
===================================================================
RCS file: /cvs/e/e17/libs/ecore/src/lib/ecore_con/ecore_con_url.c,v
retrieving revision 1.16
retrieving revision 1.17
diff -u -3 -r1.16 -r1.17
--- ecore_con_url.c 26 Sep 2007 17:18:52 -0000 1.16
+++ ecore_con_url.c 11 Feb 2008 23:24:11 -0000 1.17
@@ -40,6 +40,14 @@
#include "Ecore_Con.h"
#include "ecore_con_private.h"
+/**
+ * @defgroup Ecore_Con_Url_Group Ecore URL Connection Functions
+ *
+ * Utility functions that set up, use and shut down the Ecore URL
+ * Connection library.
+ * FIXME: write detailed description
+ */
+
#ifdef HAVE_CURL
static int _ecore_con_url_fd_handler(void *data, Ecore_Fd_Handler *fd_handler);
static int _ecore_con_url_perform(Ecore_Con_Url *url_con);
@@ -92,6 +100,12 @@
#endif
+/**
+ * Initialises the Ecore_Con_Url library.
+ * @return Number of times the library has been initialised without being
+ * shut down.
+ * @ingroup Ecore_Con_Url_Group
+ */
EAPI int
ecore_con_url_init(void)
{
@@ -135,6 +149,11 @@
#endif
}
+/**
+ * Shuts down the Ecore_Con_Url library.
+ * @return Number of calls that still uses Ecore_Con_Url
+ * @ingroup Ecore_Con_Url_Group
+ */
EAPI int
ecore_con_url_shutdown(void)
{
@@ -169,6 +188,11 @@
return 1;
}
+/**
+ * Creates and initializes a new Ecore_Con_Url.
+ * @return NULL on error, a new Ecore_Con_Url on success.
+ * @ingroup Ecore_Con_Url_Group
+ */
EAPI Ecore_Con_Url *
ecore_con_url_new(const char *url)
{
@@ -213,6 +237,11 @@
#endif
}
+/**
+ * Frees the Ecore_Con_Url.
+ * @return FIXME: To be documented.
+ * @ingroup Ecore_Con_Url_Group
+ */
EAPI void
ecore_con_url_destroy(Ecore_Con_Url *url_con)
{
@@ -242,6 +271,11 @@
#endif
}
+/**
+ * FIXME: To be documented.
+ * @return FIXME: To be documented.
+ * @ingroup Ecore_Con_Url_Group
+ */
EAPI int
ecore_con_url_url_set(Ecore_Con_Url *url_con, const char *url)
{
@@ -267,6 +301,11 @@
#endif
}
+/**
+ * FIXME: To be documented.
+ * @return FIXME: To be documented.
+ * @ingroup Ecore_Con_Url_Group
+ */
EAPI void
ecore_con_url_data_set(Ecore_Con_Url *url_con, void *data)
{
@@ -285,6 +324,11 @@
#endif
}
+/**
+ * FIXME: To be documented.
+ * @return FIXME: To be documented.
+ * @ingroup Ecore_Con_Url_Group
+ */
EAPI void *
ecore_con_url_data_get(Ecore_Con_Url *url_con)
{
@@ -302,6 +346,11 @@
#endif
}
+/**
+ * FIXME: To be documented.
+ * @return FIXME: To be documented.
+ * @ingroup Ecore_Con_Url_Group
+ */
EAPI void
ecore_con_url_time(Ecore_Con_Url *url_con, Ecore_Con_Url_Time condition,
time_t tm)
{
@@ -322,6 +371,11 @@
#endif
}
+/**
+ * FIXME: To be documented.
+ * @return FIXME: To be documented.
+ * @ingroup Ecore_Con_Url_Group
+ */
EAPI int
ecore_con_url_send(Ecore_Con_Url *url_con, void *data, size_t length, char
*content_type)
{
@@ -556,6 +610,7 @@
}
return job_matched;
}
+
static void
_ecore_con_event_url_free(void *data __UNUSED__, void *ev)
{
-------------------------------------------------------------------------
This SF.net email is sponsored by: Microsoft
Defy all challenges. Microsoft(R) Visual Studio 2008.
http://clk.atdmt.com/MRT/go/vse0120000070mrt/direct/01/
_______________________________________________
enlightenment-cvs mailing list
enlightenment-cvs@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/enlightenment-cvs
