[vlc-devel] [PATCH] playlist: clarify possible values for export type

[Romain Vimont]

---
 include/vlc_playlist.h | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)

diff --git a/include/vlc_playlist.h b/include/vlc_playlist.h
index 5b35cf6ac9..8d2ce64a27 100644
--- a/include/vlc_playlist.h
+++ b/include/vlc_playlist.h
@@ -870,8 +870,15 @@ vlc_playlist_Preparse(vlc_playlist_t *playlist, input_item_t *media);
 /**
  * Export the playlist to a file.
  *
+ * The type parameter specifies the export module (defined in
+ * `modules/misc/playlist/export.c`) to use. Possible values are:
+ *  - `"export-html"`
+ *  - `"export-m3u"`
+ *  - `"export-m3u8"`
+ *  - `"export-xspf"`
+ *
  * \param filename the location where the exported file will be saved
- * \param type the type of the playlist file to create (m3u, m3u8, xspf, ...)
+ * \param type the export module to use
  * \return VLC_SUCCESS on success, another value on error
  */
 // XXX use vlc_memstream instead of filename?
-- 
2.20.1