agent: Improve documentation for NiceAgent::new-candidate

Note that it’s a new _local_ candidate.

diff --git a/agent/agent.c b/agent/agent.c
index 15fa854..425305b 100644 (file)
--- a/agent/agent.c
+++ b/agent/agent.c
@@ -658,7 +658,7 @@ nice_agent_class_init (NiceAgentClass *klass)
    * @component_id: The ID of the component
    * @foundation: The foundation of the new candidate
    *
-   * This signal is fired when the agent discovers a new candidate
+   * This signal is fired when the agent discovers a new local candidate.
    * <para> See also: #NiceAgent::candidate-gathering-done </para>
    */
   signals[SIGNAL_NEW_CANDIDATE] =