Commit 21cbeee7 authored by Kai Vehmanen's avatar Kai Vehmanen

Fixed doxygen documentation for libsofia-sip-ua-glib (closed bug #1485968....

Fixed doxygen documentation for libsofia-sip-ua-glib (closed bug #1485968. Added example code to the su_glib doxygen documentation.

darcs-hash:20060913111226-7659e-0f9e2794ab4246158db8284fdc9f872cf2680f08.gz
parent 9bb7bc15
......@@ -52,6 +52,6 @@ doxygen: built-sources
&& ${DOXYGEN} \
&& popd > /dev/null ; \
done
# cd ${srcdir}/docs/html && ../hide_emails.sh
cd ${srcdir}/docs/html && ../../${top_srcdir}/libsofia-sip-ua/docs/hide_emails.sh
.PHONY: built-sources built-sources-am doxygen
/**@mainpage Sofia-SIP nua-glib Module
@section stun_meta Module Meta Information
@section nua_glib_meta Module Meta Information
The nua-glib module is a highlevel interface for building
SIP user-agent software, using the glib object system based.
It is basicly provides gobject bindings to the Sofia-SIP nua
module interface.
The 'nua-glib' module is a highlevel interface for building
SIP user-agent software. It is similar to the Sofia-SIP NUA
(see nua.h), but nua-glib is based on the glib object system.
@CONTACT Pekka Pessi <Pekka.Pessi@nokia.com>
......@@ -13,8 +12,13 @@ module interface.
@LICENSE LGPL
@section nua_glib_examples Examples of use
TBD
@section todo Todo
- see sourceforge.net issue tracker for sofia-sip
(-> http://sofia-sip.sourceforge.net/development.html )
*/
......@@ -4,8 +4,10 @@
@section su_glib_meta Module Meta Information
The su-glib module is a low-level interface for Sofia-SIP using the glib
primitivies.
The su-glib module provides an interface to connect Sofia-SIP event loop
to an existing glib main loop. Without this interface, a glib based
application would have to create a separate thread for running
the Sofia-SIP event loop.
@CONTACT Pekka Pessi <Pekka.Pessi@nokia.com>
......@@ -13,8 +15,39 @@ primitivies.
@LICENSE LGPL
@section todo Todo
@section su_glib_examples Examples of use
- see sourceforge.net issue tracker for sofia-sip
Below is a simple example of how to use su-glib:
@code
#include <glib.h>
#include <sofia-sip/su_glib.h>
/* ... */
GMainLoop *ptr = g_main_loop_new(NULL, FALSE);
GSource *gsource;
su_root_t *sofia_event_loop;
su_timer_t *timer;
/* create a sofia event loop using su-glib function su_glib_root_source_create() */
sofia_event_loop = su_glib_root_create(NULL);
/* attach the created GSource to glib event loop */
gsource = su_glib_root_gsource(sofia_event_loop);
g_source_attach(gsource, g_main_loop_get_context(ptr));
/* use the sofia event loop with libsofia-sip-ua modules */
timer = su_timer_create(su_root_task(sofia_event_loop), 200L);
/* ... initialize other Sofia-SIP modules/functrions */
/* run the glib mainloop */
g_main_loop_unref(ptr);
@endcode
@section su_glib_todo Todo
- see sourceforge.net issue tracker for sofia-sip
(-> http://sofia-sip.sourceforge.net/development.html )
*/
# Doxyfile 1.0.0 format
#
@INCLUDE = "../docs/Doxyfile.version"
@INCLUDE = "../docs/Doxyfile.aliases"
@INCLUDE = "../../libsofia-sip-ua/docs/Doxyfile.version"
@INCLUDE = "../../libsofia-sip-ua/docs/Doxyfile.aliases"
OUTPUT_LANGUAGE = English
......@@ -37,7 +37,7 @@ EXPAND_ONLY_PREDEF = YES
GENERATE_HTML = YES
HTML_OUTPUT = .
HTML_ALIGN_MEMBERS = YES
HTML_FOOTER = ../docs/sofia-footer.html
HTML_FOOTER = ../../libsofia-sip-ua/docs/sofia-footer.html
ALLEXTERNALS = NO
EXTERNAL_GROUPS = NO
......@@ -59,4 +59,4 @@ EXCLUDE_PATTERNS = acconfig.h config.h confdefs.h \
test*.h test*.c torture*.c *test.c *torture.c \
*_tag_dll.c *_tag_ref.c
IMAGE_PATH = ../docs/pictures
IMAGE_PATH = ../../libsofia-sip-ua/docs/pictures
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