From a68f2cb9fa75429ab05314ab79289110af10c4b4 Mon Sep 17 00:00:00 2001
From: Max Kellermann <max@musicpd.org>
Date: Sat, 17 Feb 2018 10:32:17 +0100
Subject: [PATCH] input/InputPlugin: add API documentation

---
 src/input/InputPlugin.hxx | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/src/input/InputPlugin.hxx b/src/input/InputPlugin.hxx
index 2be1c7ab5..7e278f4ae 100644
--- a/src/input/InputPlugin.hxx
+++ b/src/input/InputPlugin.hxx
@@ -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.
 	 *