[vlc-commits] vlc_stream_extractor: vlc_stream_NewMRL: fixup of documentation

[Filip Roséen]

vlc | branch: master | Filip Roséen <filip at atch.se> | Thu May 18 12:19:40 2017 +0200| [6131b9e248e024ef492cf46d5d4929f81261eca9] | committer: Rémi Denis-Courmont

vlc_stream_extractor: vlc_stream_NewMRL: fixup of documentation

This rephrasing should make the associated documentation a little
easier to comprehend.

Signed-off-by: Rémi Denis-Courmont <remi at remlab.net>

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

 include/vlc_stream_extractor.h | 7 +++----
 1 file changed, 3 insertions(+), 4 deletions(-)

diff --git a/include/vlc_stream_extractor.h b/include/vlc_stream_extractor.h
index 45c46d566d..78c51c0792 100644
--- a/include/vlc_stream_extractor.h
+++ b/include/vlc_stream_extractor.h
@@ -99,10 +99,9 @@ typedef struct stream_directory_t {
  *  - See the \ref mrl specification for further information.
  *  - The returned resource shall be deleted through \ref vlc_stream_Delete.
  *
- * \warning This function is only be used when \ref mrl functionality is
- *          explicitly needed, \ref vlc_stream_NewURL shall be used where
- *          applicable (and functionality associated with \ref MRL is not
- *          wanted nor needed).
+ * \warning This function is only to be used when \ref mrl functionality is
+ *          explicitly needed. \ref vlc_stream_NewURL shall be used where
+ *          applicable.
  *
  * \param obj the owner of the requested stream
  * \param mrl the mrl for which the stream_t should be created