Commit 7e7cf461 authored by Youness Alaoui's avatar Youness Alaoui

Adding 'Since' gtk-doc tags to specify since which version each function has...

Adding 'Since' gtk-doc tags to specify since which version each function has become available (for non 0.0.1 ones)
parent d8bc6e7d
......@@ -331,23 +331,44 @@ nice_agent_class_init (NiceAgentClass *klass)
0, /* default set in init */
G_PARAM_READWRITE));
/**
* NiceAgent:proxy-ip:
*
* The proxy server IP used to bypass a proxy firewall
*
* Since: 0.0.4
*/
g_object_class_install_property (gobject_class, PROP_PROXY_IP,
g_param_spec_string (
"proxy-ip",
"Proxy server IP",
"The proxy server used to bypass a proxy firewall",
"The proxy server IP used to bypass a proxy firewall",
NULL,
G_PARAM_READWRITE));
/**
* NiceAgent:proxy-port:
*
* The proxy server port used to bypass a proxy firewall
*
* Since: 0.0.4
*/
g_object_class_install_property (gobject_class, PROP_PROXY_PORT,
g_param_spec_uint (
"proxy-port",
"Proxy server port",
"The Proxy server used to bypass a proxy firewall",
"The Proxy server port used to bypass a proxy firewall",
1, 65536,
1,
G_PARAM_READWRITE));
/**
* NiceAgent:proxy-type:
*
* The type of proxy set in the proxy-ip property
*
* Since: 0.0.4
*/
g_object_class_install_property (gobject_class, PROP_PROXY_TYPE,
g_param_spec_uint (
"proxy-type",
......@@ -357,6 +378,13 @@ nice_agent_class_init (NiceAgentClass *klass)
NICE_PROXY_TYPE_NONE,
G_PARAM_READWRITE));
/**
* NiceAgent:proxy-username:
*
* The username used to authenticate with the proxy
*
* Since: 0.0.4
*/
g_object_class_install_property (gobject_class, PROP_PROXY_USERNAME,
g_param_spec_string (
"proxy-username",
......@@ -365,6 +393,13 @@ nice_agent_class_init (NiceAgentClass *klass)
NULL,
G_PARAM_READWRITE));
/**
* NiceAgent:proxy-password:
*
* The password used to authenticate with the proxy
*
* Since: 0.0.4
*/
g_object_class_install_property (gobject_class, PROP_PROXY_PASSWORD,
g_param_spec_string (
"proxy-password",
......@@ -373,6 +408,14 @@ nice_agent_class_init (NiceAgentClass *klass)
NULL,
G_PARAM_READWRITE));
/**
* NiceAgent:upnp:
*
* Whether the agent should use UPnP to open a port in the router and
* get the external IP
*
* Since: 0.0.7
*/
g_object_class_install_property (gobject_class, PROP_UPNP,
g_param_spec_boolean (
"upnp",
......@@ -387,6 +430,14 @@ nice_agent_class_init (NiceAgentClass *klass)
TRUE, /* enable UPnP by default */
G_PARAM_READWRITE| G_PARAM_CONSTRUCT));
/**
* NiceAgent:upnp-timeout:
*
* The maximum amount of time to wait for UPnP discovery to finish before
* signaling the candidate-gathering-done signal
*
* Since: 0.0.7
*/
g_object_class_install_property (gobject_class, PROP_UPNP_TIMEOUT,
g_param_spec_uint (
"upnp-timeout",
......@@ -564,6 +615,8 @@ nice_agent_class_init (NiceAgentClass *klass)
* This signal is only emitted when the nice_agent_send() function returns less
* bytes than requested to send (or -1) and once when the connection
* is established.
*
* Since: 0.0.11
*/
signals[SIGNAL_RELIABLE_TRANSPORT_WRITABLE] =
g_signal_new (
......
......@@ -236,6 +236,8 @@ typedef enum
* An enum to specify which proxy type to use for relaying.
* Note that the proxies will only be used with TCP TURN relaying.
* <para> See also: #NiceAgent:proxy-type </para>
*
* Since: 0.0.4
*/
typedef enum
{
......@@ -287,6 +289,8 @@ nice_agent_new (GMainContext *ctx, NiceCompatibility compat);
* assure reliability of the messages.
* The returned object must be freed with g_object_unref()
*
* Since: 0.0.11
*
* Returns: The new agent GObject
*/
NiceAgent *
......@@ -298,8 +302,14 @@ nice_agent_new_reliable (GMainContext *ctx, NiceCompatibility compat);
* @addr: The address to listen to
* If the port is 0, then a random port will be chosen by the system
*
* Add a local address from which to derive local host candidates
* Add a local address from which to derive local host candidates for
* candidate gathering.
* <para>
* Since 0.0.5, if this method is not called, libnice will automatically
* discover the local addresses available
* </para>
*
* See also: nice_agent_gather_candidates()
* Returns: %TRUE on success, %FALSE on fatal (memory allocation) errors
*/
gboolean
......@@ -367,13 +377,15 @@ gboolean nice_agent_set_relay_info(
* Start the candidate gathering process.
* Once done, #NiceAgent::candidate-gathering-done is called for the stream
*
* See also: nice_agent_add_local_address()
<note>
<para>
Local addresses can be previously set with nice_agent_add_local_address()
</para>
<para>
If no local address was previously added, then the nice agent will
automatically detect the local address using nice_interfaces_get_local_ips()
Since 0.0.5, If no local address was previously added, then the nice agent
will automatically detect the local address using
nice_interfaces_get_local_ips()
</para>
</note>
*/
......@@ -644,6 +656,7 @@ nice_agent_set_selected_remote_candidate (
*
* Sets the IP_TOS and/or IPV6_TCLASS field on the stream's sockets' options
*
* Since: 0.0.9
*/
void nice_agent_set_stream_tos (
NiceAgent *agent,
......@@ -662,6 +675,7 @@ void nice_agent_set_stream_tos (
* <para>
* The SOFTWARE attribute will only be added in the #NICE_COMPATIBILITY_DRAFT19
* and #NICE_COMPATIBILITY_WLM2009 compatibility modes.
*
* </para>
* <note>
<para>
......@@ -674,6 +688,8 @@ void nice_agent_set_stream_tos (
</para>
</note>
*
* Since: 0.0.10
*
*/
void nice_agent_set_software (NiceAgent *agent, const gchar *software);
......
......@@ -469,6 +469,7 @@ size_t stun_agent_finish_message (StunAgent *agent, StunMessage *msg,
* this will allow the #StunAgent to forget about the timed out transaction and
* free its slot for future transactions.
* </para>
* Since: 0.0.6
* Returns: %TRUE if the transaction was found, %FALSE otherwise
*/
bool stun_agent_forget_transaction (StunAgent *agent, StunTransactionId id);
......@@ -484,6 +485,7 @@ bool stun_agent_forget_transaction (StunAgent *agent, StunTransactionId id);
* <para>
* Calling this function will automatically enable the addition of the SOFTWARE
* attribute for RFC5389 and WLM2009 compatibility modes.
*
* </para>
* <note>
<para>
......@@ -496,6 +498,8 @@ bool stun_agent_forget_transaction (StunAgent *agent, StunTransactionId id);
</para>
</note>
*
* Since: 0.0.10
*
*/
void stun_agent_set_software (StunAgent *agent, const char *software);
......
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