2
0
Эх сурвалжийг харах

Last doxygen updates of today.

oej 16 жил өмнө
parent
commit
084221763b

+ 4 - 1
modules_k/presence/bind_presence.c

@@ -27,7 +27,10 @@
  */
  */
 
 
 /*! \file
 /*! \file
- * \brief Kamailio presence module
+ * \brief SIP-Router Presence :: Kamailio generic presence module
+ *
+ * This is the core presence module, used in combination with other modules.
+ *
  * \ingroup presence
  * \ingroup presence
  */
  */
 
 

+ 3 - 3
modules_k/presence/bind_presence.h

@@ -25,10 +25,10 @@
  * --------
  * --------
  *  2007-04-17  initial version (anca)
  *  2007-04-17  initial version (anca)
  */
  */
-
 /*! \file
 /*! \file
- * \brief Kamailio presence module
- * \ingroup presence 
+ * \brief SIP-Router Presence :: Kamailio generic presence module
+ *
+ * \ingroup presence
  */
  */
 
 
 
 

+ 12 - 12
modules_k/presence/doc/presence_admin.xml

@@ -27,8 +27,8 @@
 	is periodically updated in the database, while for PUBLISH only the presence
 	is periodically updated in the database, while for PUBLISH only the presence
 	or absence of stored info for a certain resource is maintained in memory
 	or absence of stored info for a certain resource is maintained in memory
 	to avoid unnecessary, costly database operations. 
 	to avoid unnecessary, costly database operations. 
-	It is possible to disable in-memory caching by configurng a fallback to database mode 
-	(by setting module parameter "fallback2db"). In this mode, in case a searched record is not 
+	It is possible to disable in-memory caching by configuring a fallback to database mode 
+	(by setting the module parameter "fallback2db"). In this mode, in case a searched record is not 
 	found in cache, the search is continued	in database. This is useful for
 	found in cache, the search is continued	in database. This is useful for
 	an architecture in which processing and memory load might be divided on 
 	an architecture in which processing and memory load might be divided on 
 	several &kamailio; instances, maybe on different servers using the same database.
 	several &kamailio; instances, maybe on different servers using the same database.
@@ -102,7 +102,7 @@
 		<programlisting format="linespecific">
 		<programlisting format="linespecific">
 ...
 ...
 modparam("presence", "db_url", 
 modparam("presence", "db_url", 
-	"mysql://openser:[email protected]/openser")
+	"&defaultdb;")
 ...
 ...
 </programlisting>
 </programlisting>
 		</example>
 		</example>
@@ -225,7 +225,7 @@ modparam("presence", "to_tag_pref", 'pres')
 		<para>
 		<para>
 		The value in seconds that should be subtracted from the expires value when
 		The value in seconds that should be subtracted from the expires value when
 		sending a 200OK for a publish. It is used for forcing the client
 		sending a 200OK for a publish. It is used for forcing the client
-		cu send an update before the old publish expires.
+		to send an update before the old publish expires.
 		</para>
 		</para>
 		<para>
 		<para>
 		<emphasis>Default value is <quote>0</quote>.
 		<emphasis>Default value is <quote>0</quote>.
@@ -265,7 +265,7 @@ modparam("presence", "max_expires", 3600)
 		<title><varname>server_address</varname> (str)</title>
 		<title><varname>server_address</varname> (str)</title>
 		<para>
 		<para>
 		The presence server address which will become the value of Contact header filed 
 		The presence server address which will become the value of Contact header filed 
-		for 200OK replies to Subscribe and Publish and in Notify messages.
+		for 200 OK replies to SUBSCRIBE and PUBLISH and in NOTIFY messages.
 		</para>
 		</para>
 		<example>
 		<example>
 		<title>Set <varname>server_address</varname> parameter</title>
 		<title>Set <varname>server_address</varname> parameter</title>
@@ -299,8 +299,8 @@ modparam("presence", "fallback2db", 1)
 		<title><varname>subs_htable_size</varname> (int)</title>
 		<title><varname>subs_htable_size</varname> (int)</title>
 		<para>
 		<para>
 		The size of the in-memory hash table to store subscription dialogs.
 		The size of the in-memory hash table to store subscription dialogs.
-        This parameter will be used as the power of 2 when computing table size.
-        </para>
+        	This parameter will be used as the power of 2 when computing table size.
+        	</para>
 		<para>
 		<para>
 		<emphasis>Default value is <quote>9 (512)</quote>.
 		<emphasis>Default value is <quote>9 (512)</quote>.
 		</emphasis>
 		</emphasis>
@@ -318,8 +318,8 @@ modparam("presence", "subs_htable_size", 11)
 	<section>
 	<section>
 		<title><varname>pres_htable_size</varname> (int)</title>
 		<title><varname>pres_htable_size</varname> (int)</title>
 		<para>
 		<para>
-        The size of the in-memory hash table to store publish records.
-        This parameter will be used as the power of 2 when computing table size.
+        	The size of the in-memory hash table to store publish records.
+        	This parameter will be used as the power of 2 when computing table size.
 		</para>
 		</para>
 		<para>
 		<para>
 		<emphasis>Default value is <quote>9 (512)</quote>.
 		<emphasis>Default value is <quote>9 (512)</quote>.
@@ -368,10 +368,10 @@ modparam("presence", "enable_sphere_check", 1)
 		</title>
 		</title>
 		<para>
 		<para>
 		Handles PUBLISH requests by storing and updating 
 		Handles PUBLISH requests by storing and updating 
-		published information in memory cach and database, then calls functions to send 
+		published information in memory cache and database, then calls functions to send 
 		NOTIFY messages when changes in the published information occur.
 		NOTIFY messages when changes in the published information occur.
 		It takes one argument -> sender_uri. The parameter was added 
 		It takes one argument -> sender_uri. The parameter was added 
-		for enabling BLA implementation. If present, Notification of
+		for enabling BLA implementation. If present, notification of
 		a change in published state is not sent to the respective uri
 		a change in published state is not sent to the respective uri
 		even though a subscription exists.
 		even though a subscription exists.
 		It should be taken from the Sender header. It was left at the
 		It should be taken from the Sender header. It was left at the
@@ -425,7 +425,7 @@ modparam("presence", "enable_sphere_check", 1)
 		</title>
 		</title>
 		<para>
 		<para>
 		The function which handles SUBSCRIBE requests. It stores or 
 		The function which handles SUBSCRIBE requests. It stores or 
-		updates information in memory and database and calls functions to send Notify 
+		updates information in memory and database and calls functions to send NOTIFY 
 		messages when a SUBSCRIBE which initiate a dialog is received
 		messages when a SUBSCRIBE which initiate a dialog is received
 		</para>
 		</para>
 		<para>
 		<para>