[vlc-commits] demux: document s

[Rémi Denis-Courmont]

vlc | branch: master | Rémi Denis-Courmont <remi at remlab.net> | Tue Jun 28 22:39:39 2016 +0300| [455ae373cf44e421081a10b53fd8f03fc1ffb6e5] | committer: Rémi Denis-Courmont

demux: document s

> http://git.videolan.org/gitweb.cgi/vlc.git/?a=commit;h=455ae373cf44e421081a10b53fd8f03fc1ffb6e5
---

 include/vlc_demux.h |   22 +++++++++++++++++-----
 1 file changed, 17 insertions(+), 5 deletions(-)

diff --git a/include/vlc_demux.h b/include/vlc_demux.h
index 3c121d2..9200a64 100644
--- a/include/vlc_demux.h
+++ b/include/vlc_demux.h
@@ -53,11 +53,23 @@ struct demux_t
     char        *psz_location;
     char        *psz_file;
 
-    /* input stream */
-    union
-    {
-        stream_t    *s;     /* NULL in case of a access+demux in one */
-        demux_t     *p_next;/* demux_t filter chaining */
+    union {
+        /**
+         * Input stream
+         *
+         * Depending on the module capability:
+         * - "demux": input byte stream (not NULL)
+         * - "access_demux": a NULL pointer
+         * - "demux_filter": undefined
+         */
+        stream_t *s;
+        /**
+         * Input demuxer
+         *
+         * If the module capability is "demux_filter", this is the upstream
+         * demuxer or demux filter. Otherwise, this is undefined.
+         */
+        demux_t *p_next;
     };
 
     /* es output */