Commit 8e6217fa authored by Kai Vehmanen's avatar Kai Vehmanen

Added documentation to su_glib.

darcs-hash:20070124134047-7659e-2a6cd59f30d8af1edbfeac5416646f53e56ea066.gz
parent 0a539ffc
......@@ -25,7 +25,11 @@
/**
* @file su_source.c
* @brief Wrapper for glib GSource.
* *
*
* Refs:
* - http://sofia-sip.sourceforge.net/refdocs/su/group__su__wait.html
* - http://developer.gnome.org/doc/API/glib/glib-the-main-event-loop.html
*
* @author Pekka Pessi <Pekka.Pessi@nokia.com>.
*
* @date Created: Thu Mar 4 15:15:15 2004 ppessi
......@@ -238,6 +242,15 @@ su_root_t *su_root_source_create(su_root_magic_t *magic)
return su_glib_root_create(magic);
}
/**
* Returns a GSource object for the root
*
* Note that you need to unref the GSource with g_source_unref()
* before destroying the root object.
*
* @return NULL on error (for instance if root was not created with
* su_glib_root_create())
*/
GSource *su_glib_root_gsource(su_root_t *root)
{
g_assert(root);
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment