Client Documentation

doc/doxygen/Makefile.am

@@ -5,7 +5,7 @@ html_parent_dir = .
 HTML_HEADER = 
 HTML_FOOTER = 
 
-all:
+all: doxygen-trac
 	
 .PHONY: doxygen-trac
 

doc/doxygen/core-doc.cfg.in

@@ -4,7 +4,7 @@
 # Project related configuration options
 #---------------------------------------------------------------------------
 DOXYFILE_ENCODING      = UTF-8
-PROJECT_NAME           = SFLPhoneCore
+PROJECT_NAME           = SFLphone Core
 PROJECT_NUMBER         = 
 OUTPUT_DIRECTORY       = 
 CREATE_SUBDIRS         = NO
@@ -75,10 +75,10 @@ WARN_LOGFILE           =
 #---------------------------------------------------------------------------
 # configuration options related to the input files
 #---------------------------------------------------------------------------
-INPUT                  = @-top_srcdir-@/src
+INPUT                  = @-top_srcdir-@/src @-top_srcdir-@/src/audio @-top_srcdir-@/src/audio/codecs @-top_srcdir-@/src/dbus @-top_srcdir-@/src/config @-top_srcdir-@/src/zeroconf
 INPUT_ENCODING         = UTF-8
 FILE_PATTERNS          = 
-RECURSIVE              = YES
+RECURSIVE              = NO
 EXCLUDE                = 
 EXCLUDE_SYMLINKS       = NO
 EXCLUDE_PATTERNS       = 

doc/doxygen/gtk-gui-doc.cfg.in

@@ -26,7 +26,7 @@ INHERIT_DOCS           = YES
 SEPARATE_MEMBER_PAGES  = NO
 TAB_SIZE               = 8
 ALIASES                = 
-OPTIMIZE_OUTPUT_FOR_C  = YESsrc
+OPTIMIZE_OUTPUT_FOR_C  = YES
 OPTIMIZE_OUTPUT_JAVA   = NO
 BUILTIN_STL_SUPPORT    = NO
 CPP_CLI_SUPPORT        = NO
@@ -78,7 +78,7 @@ WARN_LOGFILE           =
 INPUT                  = @-top_srcdir-@/sflphone-gtk/src 
 INPUT_ENCODING         = UTF-8
 FILE_PATTERNS          = 
-RECURSIVE              = YES
+RECURSIVE              = NO 
 EXCLUDE                = 
 EXCLUDE_SYMLINKS       = NO
 EXCLUDE_PATTERNS       = 

sflphone-gtk/src/accountlist.h

@@ -89,7 +89,7 @@ void account_list_remove (const gchar * accountID);
 
 /** 
  * Return the first account that corresponds to the state 
- * @param s The state
+ * @param state The state
  * @return account_t* An account or NULL 
  */
 account_t * account_list_get_by_state ( account_state_t state);

sflphone-gtk/src/actions.h

@@ -95,43 +95,43 @@ void sflphone_pick_up ();
 
 /**
  * Put the call on hold state
- * @param call_t* The current call
+ * @param c The current call
  */
 void sflphone_hold ( call_t * c);
 
 /**
  * Put the call in Ringing state
- * @param call_t* The current call
+ * @param c* The current call
  */
 void sflphone_ringing(call_t * c );
 
 /**
  * Put the call in Busy state
- * @param call_t* The current call
+ * @param c* The current call
  */
 void sflphone_busy( call_t * c );
 
 /**
  * Put the call in Failure state
- * @param call_t* The current call
+ * @param c* The current call
  */
 void sflphone_fail( call_t * c );
 
 /**
  * Put the call in Current state
- * @param call_t* The current call
+ * @param c The current call
  */
 void sflphone_current ( call_t * c);
 
 /**
  * The callee has hung up 
- * @param call_t* The current call
+ * @param c The current call
  */
 void sflphone_hung_up( call_t * c);
 
 /**
  * Incoming call
- * @param call_t* The incoming call
+ * @param c The incoming call
  */
 void sflphone_incoming_call ( call_t * c);
 
@@ -139,7 +139,7 @@ void sflphone_incoming_call ( call_t * c);
  * Dial the number
  * If the call is in DIALING state, the char will be append to the number
  * @param keyval The unique int representing the key
- * @param keyval The char value of the key
+ * @param key The char value of the key
  */
 void sflphone_keypad ( guint keyval, gchar * key);
 

sflphone-gtk/src/calllist.h

@@ -113,8 +113,8 @@ call_t * call_list_get_nth ( guint n );
 
 /** 
  * Return the call corresponding to the callID
- * @param n The callID of the call you want
- * @return A call or NULL 
+ * @param callID The callID of the call you want
+ * @return call_t*  A call or NULL 
  */
 call_t * call_list_get ( const gchar * callID );
 

sflphone-gtk/src/codeclist.h

@@ -58,7 +58,7 @@ void codec_list_clear();
 
 /** 
  * This function append an codec to list. 
- * @param a The codec you want to add 
+ * @param c The codec you want to add 
  */
 void codec_list_add(codec_t * c);
 

sflphone-gtk/src/dbus.c

@@ -837,9 +837,6 @@ dbus_get_output_audio_plugin_list()
 	return array;
 }
 
-/**
- * Sets the input audio plugin from its name
- */
 void
 dbus_set_input_audio_plugin(gchar* audioPlugin)
 {
@@ -859,9 +856,6 @@ dbus_set_input_audio_plugin(gchar* audioPlugin)
 		g_print("DBus called set_input_audio_plugin() on ConfigurationManager\n");
 }
 
-/**
- * Sets the output audio plugin from its name
- */
 void
 dbus_set_output_audio_plugin(gchar* audioPlugin)
 {

sflphone-gtk/src/dbus.h

@@ -190,13 +190,13 @@ gchar** dbus_get_output_audio_plugin_list();
 
 /**
  * ConfigurationManager - Select an input audio plugin
- * @param gchar* The string description of the plugin
+ * @param audioPlugin The string description of the plugin
  */
 void dbus_set_input_audio_plugin(gchar* audioPlugin);
 
 /**
  * ConfigurationManager - Select an output audio plugin
- * @param gchar* The string description of the plugin
+ * @param audioPlugin The string description of the plugin
  */
 void dbus_set_output_audio_plugin(gchar* audioPlugin);
 

sflphone-gtk/src/menus.h

@@ -38,7 +38,7 @@ void update_menus();
 
 /**
  * Create a menu on right-click
- * @param mywidget The widget you click on
+ * @param my_widget The widget you click on
  * @param event The mouse event
  */
 void show_popup_menu (GtkWidget *my_widget, GdkEventButton *event);

sflphone-gtk/src/sflphone_const.h

@@ -20,11 +20,12 @@
 #ifndef __SFLPHONE_CONST_H
 #define __SFLPHONE_CONST_H
 
+#include <libintl.h>
+#include "dbus.h"
+
 /* @file sflphone_const.h
  * @brief Contains the global variables for the client code
  */
-#include <libintl.h>
-#include "dbus.h"
 
 /** Locale */
 #define _(STRING)   gettext( STRING )   

sflphone-gtk/src/sliders.c

@@ -98,12 +98,6 @@ mute_cb( GtkWidget *widget, gchar*  device )
   update_icons (dev);
 }
 
-/** This function updates the sliders without sending the value to the server.
-  * This behavior prevents an infinite loop when receiving an updated volume from
-  * the server.
-  * @param device The device slider to update {speaker, mic}
-  * @param value The value to set [0, 1.0]
-  */
 void 
 set_slider(const gchar * device, gdouble newval)
 {

sflphone-gtk/src/sliders.h

@@ -32,10 +32,13 @@
  */
 GtkWidget * create_slider(const gchar * device);
 
+
 /** 
- * Change the value of the specified device
- * @param device Mic or speaker
- * @param value	The new value
+ * This function updates the sliders without sending the value to the server.
+ * This behavior prevents an infinite loop when receiving an updated volume from
+ * the server.
+ * @param device The device slider to update {speaker, mic}
+ * @param value The value to set [0, 1.0]
  */
 void set_slider(const gchar * device, gdouble value);