summaryrefslogtreecommitdiffstats
path: root/src/pulse/def.h
diff options
context:
space:
mode:
authorLennart Poettering <lennart@poettering.net>2009-01-19 23:54:44 +0100
committerLennart Poettering <lennart@poettering.net>2009-01-19 23:54:44 +0100
commit8886e66ff68f5f23a2cacb06df6cb85a0175b7f1 (patch)
treeab096ab1656d2b8c337cf11efbb0600cdfc3f758 /src/pulse/def.h
parent310f433848b21a53def0a5a5ca0b3b2e6a2008ef (diff)
Document explicitly that the internal sink/source states are not considered part of the ABI/API
Diffstat (limited to 'src/pulse/def.h')
-rw-r--r--src/pulse/def.h24
1 files changed, 18 insertions, 6 deletions
diff --git a/src/pulse/def.h b/src/pulse/def.h
index 8e8857c1..21a02bcc 100644
--- a/src/pulse/def.h
+++ b/src/pulse/def.h
@@ -627,13 +627,19 @@ typedef enum pa_sink_state { /* enum serialized in u8 */
PA_SINK_SUSPENDED = 2,
/**< When suspended, actual sink access can be closed, for instance \since 0.9.15 */
- /* *** PRIVATE: server-side values *** */
+/** \cond fulldocs */
+ /* PRIVATE: Server-side values -- DO NOT USE THIS ON THE CLIENT
+ * SIDE! These values are *not* considered part of the official PA
+ * API/ABI. If you use them your application might break when PA
+ * is upgraded. Also, please note that these values are not useful
+ * on the client side anyway. */
PA_SINK_INIT = -2,
- /* Initialization state */
+ /**< Initialization state */
PA_SINK_UNLINKED = -3
- /* The state when the sink is getting unregistered and removed from client access */
+ /**< The state when the sink is getting unregistered and removed from client access */
+/** \endcond */
} pa_sink_state_t;
@@ -696,13 +702,19 @@ typedef enum pa_source_state {
PA_SOURCE_SUSPENDED = 2,
/**< When suspended, actual source access can be closed, for instance \since 0.9.15 */
- /* *** PRIVATE: server-side values *** */
+/** \cond fulldocs */
+ /* PRIVATE: Server-side values -- DO NOT USE THIS ON THE CLIENT
+ * SIDE! These values are *not* considered part of the official PA
+ * API/ABI. If you use them your application might break when PA
+ * is upgraded. Also, please note that these values are not useful
+ * on the client side anyway. */
PA_SOURCE_INIT = -2,
- /* Initialization state */
+ /**< Initialization state */
PA_SOURCE_UNLINKED = -3
- /* The state when the source is getting unregistered and removed from client access */
+ /**< The state when the source is getting unregistered and removed from client access */
+/** \endcond */
} pa_source_state_t;