[vlc-commits] stream: clean up vlc_stream_ReadDir() documentation

[Rémi Denis-Courmont]

vlc | branch: master | Rémi Denis-Courmont <remi at remlab.net> | Sat Mar 31 15:32:10 2018 +0300| [ab6c0897df3060403b43bd109497f01f2f0f87c6] | committer: Rémi Denis-Courmont

stream: clean up vlc_stream_ReadDir() documentation

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

 include/vlc_stream.h | 13 ++++++++++++-
 src/input/stream.c   |  4 ----
 2 files changed, 12 insertions(+), 5 deletions(-)

diff --git a/include/vlc_stream.h b/include/vlc_stream.h
index 447715fd5c..4fb7212651 100644
--- a/include/vlc_stream.h
+++ b/include/vlc_stream.h
@@ -318,7 +318,18 @@ static inline int vlc_stream_Control(stream_t *s, int query, ...)
 
 VLC_API block_t *vlc_stream_Block(stream_t *s, size_t);
 VLC_API char *vlc_stream_ReadLine(stream_t *);
-VLC_API int vlc_stream_ReadDir(stream_t *, input_item_node_t *);
+
+/**
+ * Reads a directory.
+ *
+ * This function fills an input item node with any and all the items within
+ * a directory. The behaviour is undefined if the stream is not a directory.
+ *
+ * \param s directory object to read from
+ * \param node node to store the items into
+ * \return VLC_SUCCESS on success
+ */
+VLC_API int vlc_stream_ReadDir(stream_t *s, input_item_node_t *node);
 
 /**
  * Closes a byte stream.
diff --git a/src/input/stream.c b/src/input/stream.c
index 90db206d4b..e79a752d7d 100644
--- a/src/input/stream.c
+++ b/src/input/stream.c
@@ -716,10 +716,6 @@ block_t *vlc_stream_Block( stream_t *s, size_t size )
     return block;
 }
 
-/**
- * Returns a node containing all the input_item of the directory pointer by
- * this stream. returns VLC_SUCCESS on success.
- */
 int vlc_stream_ReadDir( stream_t *s, input_item_node_t *p_node )
 {
     assert(s->pf_readdir != NULL);