oysteikt/mpd
0
0
Fork 0
Code Issues Pull Requests Releases Activity

input/InputPlugin: add API documentation

Browse Source
This commit is contained in:
Max Kellermann 2018-02-17 10:32:17 +01:00
parent 5f5be823f3
commit a68f2cb9fa
1 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
src/input/InputPlugin.hxx
View File

@ -49,6 +49,9 @@ struct InputPlugin {
void (*finish)();
/**
* Attempt to open the given URI. Returns nullptr if the
* plugin does not support this URI.
*
* Throws std::runtime_error on error.
*/
InputStreamPtr (*open)(const char *uri,
@ -56,7 +59,8 @@ struct InputPlugin {
/**
* Prepare a #RemoteTagScanner. The operation must be started
* using RemoteTagScanner::Start().
* using RemoteTagScanner::Start(). Returns nullptr if the
* plugin does not support this URI.
*
* Throws on error.
*