[farsight2/master] Document the Session/Stream error quarks

Olivier Crête olivier.crete at collabora.co.uk
Tue Dec 23 15:19:13 PST 2008


---
 gst-libs/gst/farsight/fs-session.h |    6 ++++++
 gst-libs/gst/farsight/fs-stream.h  |    6 ++++++
 2 files changed, 12 insertions(+), 0 deletions(-)

diff --git a/gst-libs/gst/farsight/fs-session.h b/gst-libs/gst/farsight/fs-session.h
index 44af804..d6d99db 100644
--- a/gst-libs/gst/farsight/fs-session.h
+++ b/gst-libs/gst/farsight/fs-session.h
@@ -111,6 +111,12 @@ typedef enum {
   FS_SESSION_ERROR_CONSTRUCTION
 } FsSessionError;
 
+/**
+ * FS_SESSION_ERROR
+ *
+ * This quark is used to denote errors coming from the #FsSession object
+ */
+
 #define FS_SESSION_ERROR (fs_session_error_quark ())
 
 GQuark fs_session_error_quark (void);
diff --git a/gst-libs/gst/farsight/fs-stream.h b/gst-libs/gst/farsight/fs-stream.h
index 3350d7e..b5b5b39 100644
--- a/gst-libs/gst/farsight/fs-stream.h
+++ b/gst-libs/gst/farsight/fs-stream.h
@@ -87,6 +87,12 @@ typedef enum {
   FS_STREAM_ERROR_INVALID_ARGUMENTS
 } FsStreamError;
 
+/**
+ * FS_STREAM_ERROR:
+ *
+ * This quark is used to denote errors coming from the #FsStream object
+ */
+
 #define FS_STREAM_ERROR (fs_stream_error_quark ())
 
 GQuark fs_stream_error_quark (void);
-- 
1.5.6.5




More information about the farsight-commits mailing list