Commit b5d0c1fd authored by Youness Alaoui's avatar Youness Alaoui

fix some warnings by removing gtk-doc comment where not needed

parent b08c2237
......@@ -184,11 +184,6 @@ nice_address_get_port (const NiceAddress *addr)
}
/**
* address_set_from_string ()
*
* Returns FALSE on error.
*/
NICEAPI_EXPORT gboolean
nice_address_set_from_string (NiceAddress *addr, const gchar *str)
{
......@@ -209,9 +204,6 @@ nice_address_set_from_string (NiceAddress *addr, const gchar *str)
}
/**
* Sets address to match socket address struct 'sin'.
*/
NICEAPI_EXPORT void
nice_address_set_from_sockaddr (NiceAddress *addr,
const struct sockaddr *sa)
......@@ -230,9 +222,6 @@ nice_address_set_from_sockaddr (NiceAddress *addr,
}
/**
* Copies NiceAddress to socket address struct 'sin'.
*/
NICEAPI_EXPORT void
nice_address_copy_to_sockaddr (const NiceAddress *addr,
struct sockaddr *sa)
......
......@@ -156,7 +156,7 @@ GType nice_agent_get_type (void);
/**
* NICE_AGENT_MAX_REMOTE_CANDIDATES:
*
* A hard limit for number for remote candidates. This
* A hard limit for the number of remote candidates. This
* limit is enforced to protect against malevolent remote
* clients.
*/
......@@ -175,7 +175,7 @@ GType nice_agent_get_type (void);
* @NICE_COMPONENT_STATE_LAST: Dummy state
*
* An enum representing the state of a component.
* See #NiceAgent::component-state-changed
* <para> See also: #NiceAgent::component-state-changed </para>
*/
typedef enum
{
......@@ -238,7 +238,7 @@ 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.
* See #NiceAgent:proxy-type
* <para> See also: #NiceAgent:proxy-type </para>
*/
typedef enum
{
......
......@@ -1778,7 +1778,7 @@ static gboolean priv_map_reply_to_conn_check_request (NiceAgent *agent, Stream *
/* step: updating nominated flag (ICE 7.1.2.2.4 "Updating the
Nominated Flag" (ID-19) */
if (ok_pair->nominated == TRUE)
if (ok_pair->nominated == TRUE)
priv_update_selected_pair (agent, component, ok_pair);
/* step: update pair states (ICE 7.1.2.2.3 "Updating pair
......
......@@ -35,6 +35,20 @@
#ifndef _STUN_AGENT_H
#define _STUN_AGENT_H
/**
* SECTION:stunagent
* @short_description: STUN agent for building and validating STUN messages
* @see_also: #StunMessage
* @stability: Stable
*
* The STUN Agent allows you to create and validate STUN messages easily.
* It's main purpose is to make sure the building and validation methods used
* are compatible with the RFC you create it with. It also tracks the transaction
* ids of the requests you send, so you can validate if a STUN response you
* received should be processed by that agent or not.
*
*/
#ifdef _WIN32
#include "win32_common.h"
......
......@@ -36,7 +36,7 @@
#ifndef STUN_BIND_H
# define STUN_BIND_H 1
/**
/*
* @file bind.h
* @brief STUN binding discovery
*/
......
......@@ -36,7 +36,7 @@
#ifndef STUN_CONNCHECK_H
# define STUN_CONNCHECK_H 1
/**
/*
* @file ice.h
* @brief STUN/ICE connectivity checks
*/
......
......@@ -53,7 +53,7 @@
#include <sys/types.h>
/**
/*
* Initial STUN timeout (milliseconds). The spec says it should be 100ms,
* but that's way too short for most types of wireless Internet access.
*/
......@@ -69,7 +69,7 @@
#endif
/**
/*
* Clock used throughout the STUN code.
* STUN requires a monotonic 1kHz clock to operate properly.
*/
......
......@@ -36,7 +36,7 @@
#ifndef STUN_TIMER_H
# define STUN_TIMER_H 1
/**
/*
* @file timer.h
* @brief STUN retransmission timer
*/
......
......@@ -36,7 +36,7 @@
#ifndef STUN_TURN_H
# define STUN_TURN_H 1
/**
/*
* @file bind.h
* @brief STUN binding discovery
*/
......
......@@ -472,7 +472,7 @@ static int run_full_test (NiceAgent *lagent, NiceAgent *ragent, NiceAddress *bas
return 0;
}
/**
/*
* Simulate the case where answer to the offer is delayed and
* some STUN connectivity checks reach the offering party
* before it gets the remote SDP information.
......
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