[vlc-commits] demux: extend demux_FilterChainNew() documentation

[Rémi Denis-Courmont]

vlc | branch: master | Rémi Denis-Courmont <remi at remlab.net> | Fri Feb 23 19:01:58 2018 +0200| [2e3120ad713190473134af431db78fbe9b25e033] | committer: Rémi Denis-Courmont

demux: extend demux_FilterChainNew() documentation

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

 src/input/demux.h | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/src/input/demux.h b/src/input/demux.h
index 00be2e9ab8..2e9f499c93 100644
--- a/src/input/demux.h
+++ b/src/input/demux.h
@@ -51,6 +51,11 @@ int demux_GetSeekpoint( demux_t * );
  * @param source input stream around which to build a filter chain
  * @param list colon-separated list of stream filters (upstream first)
  *
+ * @note Like stream_FilterAutoNew(), this function takes ownership of the
+ * source input stream, and transfers it to the first demux filter in the
+ * constructed chain. Any use of the source after the function call is invalid
+ * and undefined (unless the chain ends up empty).
+ *
  * @return The last demux (filter) in the chain.
  * The return value is always a valid (non-NULL) demux pointer.
  */