playlist/Stream: add API documentation
This commit is contained in:
parent
4e7b554605
commit
eceead671e
@ -1,8 +1,7 @@
|
|||||||
// SPDX-License-Identifier: GPL-2.0-or-later
|
// SPDX-License-Identifier: GPL-2.0-or-later
|
||||||
// Copyright The Music Player Daemon Project
|
// Copyright The Music Player Daemon Project
|
||||||
|
|
||||||
#ifndef MPD_PLAYLIST_STREAM_HXX
|
#pragma once
|
||||||
#define MPD_PLAYLIST_STREAM_HXX
|
|
||||||
|
|
||||||
#include "thread/Mutex.hxx"
|
#include "thread/Mutex.hxx"
|
||||||
|
|
||||||
@ -20,8 +19,12 @@ class Path;
|
|||||||
std::unique_ptr<SongEnumerator>
|
std::unique_ptr<SongEnumerator>
|
||||||
playlist_open_path(Path path, Mutex &mutex);
|
playlist_open_path(Path path, Mutex &mutex);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Opens a playlist from a remote file.
|
||||||
|
*
|
||||||
|
* @param uri the absolute URI of the playlist file
|
||||||
|
* @return a playlist, or nullptr on error
|
||||||
|
*/
|
||||||
[[gnu::nonnull]]
|
[[gnu::nonnull]]
|
||||||
std::unique_ptr<SongEnumerator>
|
std::unique_ptr<SongEnumerator>
|
||||||
playlist_open_remote(const char *uri, Mutex &mutex);
|
playlist_open_remote(const char *uri, Mutex &mutex);
|
||||||
|
|
||||||
#endif
|
|
||||||
|
Loading…
Reference in New Issue
Block a user