[farsight2/master] Fix documentation lines to use proper prefixes for constants
Olivier Crête
olivier.crete at collabora.co.uk
Tue Dec 23 15:20:44 PST 2008
---
gst-libs/gst/farsight/fs-conference-iface.c | 4 ++--
gst-libs/gst/farsight/fs-session.c | 16 ++++++++--------
gst-libs/gst/farsight/fs-stream.c | 8 ++++----
3 files changed, 14 insertions(+), 14 deletions(-)
diff --git a/gst-libs/gst/farsight/fs-conference-iface.c b/gst-libs/gst/farsight/fs-conference-iface.c
index eb2db94..6545639 100644
--- a/gst-libs/gst/farsight/fs-conference-iface.c
+++ b/gst-libs/gst/farsight/fs-conference-iface.c
@@ -91,7 +91,7 @@ fs_conference_iface_init (FsConferenceClass * iface)
* fs_conference_new_session
* @conference: #FsConference interface of a #GstElement
* @media_type: #FsMediaType of the new session
- * @error: location of a #GError, or NULL if no error occured
+ * @error: location of a #GError, or %NULL if no error occured
*
* Create a new Farsight session for the given conference.
*
@@ -118,7 +118,7 @@ fs_conference_new_session (FsConference *conference, FsMediaType media_type,
* fs_conference_new_participant
* @conference: #FsConference interface of a #GstElement
* @cname: The cname of the participant
- * @error: location of a #GError, or NULL if no error occured
+ * @error: location of a #GError, or %NULL if no error occured
*
* Create a new Farsight Participant for the type of the given conference.
*
diff --git a/gst-libs/gst/farsight/fs-session.c b/gst-libs/gst/farsight/fs-session.c
index d3383b6..0d82479 100644
--- a/gst-libs/gst/farsight/fs-session.c
+++ b/gst-libs/gst/farsight/fs-session.c
@@ -158,7 +158,7 @@ fs_session_class_init (FsSessionClass *klass)
* installed GStreamer plugins. This list is unchanged during the lifecycle of
* the session unless local-codecs-config is changed by the user. It is a
* #GList of #FsCodec. User must free this codec list using
- * #fs_codec_list_destroy() when done.
+ * fs_codec_list_destroy() when done.
*
*/
g_object_class_install_property (gobject_class,
@@ -177,7 +177,7 @@ fs_session_class_init (FsSessionClass *klass)
* change this value during an ongoing session. Note that doing this can cause
* the local-codecs to be changed. Therefore this requires the user to fetch
* the new local-codecs and renegotiate them with the peers. It is a #GList
- * of #FsCodec. User must free this codec list using #fs_codec_list_destroy()
+ * of #FsCodec. User must free this codec list using fs_codec_list_destroy()
* when done.
*
*/
@@ -196,7 +196,7 @@ fs_session_class_init (FsSessionClass *klass)
* This list indicated what codecs have been successfully negotiated with the
* session participants. This list can change based on participants
* joining/leaving the session. It is a #GList of #FsCodec. User must free
- * this codec list using #fs_codec_list_destroy() when done.
+ * this codec list using fs_codec_list_destroy() when done.
*
*/
g_object_class_install_property (gobject_class,
@@ -335,7 +335,7 @@ fs_session_error_forward (GObject *signal_src,
* @stream_transmitter_parameters: an array of n_parameters #GParameter struct
* that will be passed
* to the newly-create #FsStreamTransmitter
- * @error: location of a #GError, or NULL if no error occured
+ * @error: location of a #GError, or %NULL if no error occured
*
* This function creates a stream for the given participant into the active session.
*
@@ -384,9 +384,9 @@ fs_session_new_stream (FsSession *session, FsParticipant *participant,
*
* This function will start sending a telephony event (such as a DTMF
* tone) on the #FsSession. You have to call the function
- * #fs_session_stop_telephony_event() to stop it.
+ * fs_session_stop_telephony_event() to stop it.
* This function will use any available method, if you want to use a specific
- * method only, use #fs_session_start_telephony_event_full()
+ * method only, use fs_session_start_telephony_event_full()
*
* Returns: %TRUE if sucessful, it can return %FALSE if the #FsStream
* does not support this telephony event.
@@ -411,7 +411,7 @@ fs_session_start_telephony_event (FsSession *session, guint8 event,
* @method: The method used to send the event
*
* This function will stop sending a telephony event started by
- * #fs_session_start_telephony_event(). If the event was being sent
+ * fs_session_start_telephony_event(). If the event was being sent
* for less than 50ms, it will be sent for 50ms minimum. If the
* duration was a positive and the event is not over, it will cut it
* short.
@@ -436,7 +436,7 @@ fs_session_stop_telephony_event (FsSession *session, FsDTMFMethod method)
* fs_session_set_send_codec:
* @session: an #FsSession
* @send_codec: an #FsCodec representing the codec to send
- * @error: location of a #GError, or NULL if no error occured
+ * @error: location of a #GError, or %NULL if no error occured
*
* This function will set the currently being sent codec for all streams in this
* session. The given #FsCodec must be taken directly from the #negotiated-codecs
diff --git a/gst-libs/gst/farsight/fs-stream.c b/gst-libs/gst/farsight/fs-stream.c
index 448c9fa..3163e49 100644
--- a/gst-libs/gst/farsight/fs-stream.c
+++ b/gst-libs/gst/farsight/fs-stream.c
@@ -376,7 +376,7 @@ fs_stream_set_property (GObject *object,
* fs_stream_add_remote_candidate:
* @stream: an #FsStream
* @candidate: an #FsCandidate struct representing a remote candidate
- * @error: location of a #GError, or NULL if no error occured
+ * @error: location of a #GError, or %NULL if no error occured
*
* This function adds the given candidate into the remote candiate list of the
* stream. It will be used for establishing a connection with the peer. A copy
@@ -426,7 +426,7 @@ fs_stream_remote_candidates_added (FsStream *stream)
* @stream: a #FsStream
* @lfoundation: The foundation of the local candidate to be selected
* @rfoundation: The foundation of the remote candidate to be selected
- * @error: location of a #GError, or NULL if no error occured
+ * @error: location of a #GError, or %NULL if no error occured
*
* This function selects one pair of candidates to be selected to start
* sending media on.
@@ -455,7 +455,7 @@ fs_stream_select_candidate_pair (FsStream *stream, gchar *lfoundation,
* fs_stream_preload_recv_codec:
* @stream: an #FsStream
* @codec: The #FsCodec to be preloaded
- * @error: location of a #GError, or NULL if no error occured
+ * @error: location of a #GError, or %NULL if no error occured
*
* This function will preload the codec corresponding to the given codec.
* This codec must correspond exactly to one of the local-codecs returned by
@@ -484,7 +484,7 @@ fs_stream_preload_recv_codec (FsStream *stream, FsCodec *codec, GError **error)
* fs_stream_set_remote_codecs:
* @stream: an #FsStream
* @remote_codecs: a #GList of #FsCodec representing the remote codecs
- * @error: location of a #GError, or NULL if no error occured
+ * @error: location of a #GError, or %NULL if no error occured
*
* This function will set the list of remote codecs for this stream. If
* the given remote codecs couldn't be negotiated with the list of local
--
1.5.6.5
More information about the farsight-commits
mailing list