summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPhilip Withnall <philip.withnall@collabora.co.uk>2015-03-10 12:25:25 +0000
committerPhilip Withnall <philip.withnall@collabora.co.uk>2015-03-10 12:25:25 +0000
commit6a5ae86a8f90e39603f85c5156411f7cfb3ec381 (patch)
tree4dfaeb48538624846ffb8be108eba3dc2e96c74f
parent929f7cec8354d1eff27f0bcd356ab110e48e94aa (diff)
downloadlibnice-6a5ae86a8f90e39603f85c5156411f7cfb3ec381.tar.gz
agent: Fix documentation to use ‘nul-terminated’ for strings
NULL is ((gpointer) 0). nul is '\0'. Arrays can be NULL terminated. Strings can be nul terminated.
-rw-r--r--agent/agent.h4
-rw-r--r--agent/candidate.h4
2 files changed, 4 insertions, 4 deletions
diff --git a/agent/agent.h b/agent/agent.h
index d96ce6a..151f60e 100644
--- a/agent/agent.h
+++ b/agent/agent.h
@@ -563,9 +563,9 @@ nice_agent_gather_candidates (
* nice_agent_set_remote_credentials:
* @agent: The #NiceAgent Object
* @stream_id: The ID of the stream
- * @ufrag: NULL-terminated string containing an ICE username fragment
+ * @ufrag: nul-terminated string containing an ICE username fragment
* (length must be between 22 and 256 chars)
- * @pwd: NULL-terminated string containing an ICE password
+ * @pwd: nul-terminated string containing an ICE password
* (length must be between 4 and 256 chars)
*
* Sets the remote credentials for stream @stream_id.
diff --git a/agent/candidate.h b/agent/candidate.h
index 8c79f15..3111a4d 100644
--- a/agent/candidate.h
+++ b/agent/candidate.h
@@ -193,8 +193,8 @@ struct _NiceCandidate
guint stream_id;
guint component_id;
gchar foundation[NICE_CANDIDATE_MAX_FOUNDATION];
- gchar *username; /* pointer to a NULL-terminated username string */
- gchar *password; /* pointer to a NULL-terminated password string */
+ gchar *username; /* pointer to a nul-terminated username string */
+ gchar *password; /* pointer to a nul-terminated password string */
TurnServer *turn;
gpointer sockptr;
};