From e1a8dcfcc8d08a0426154fed457be1abec2abfa3 Mon Sep 17 00:00:00 2001
From: Max Kellermann <max@musicpd.org>
Date: Thu, 27 Oct 2016 19:55:08 +0200
Subject: [PATCH] storage/Composite: add FindStorage() API documentation

---
 src/storage/CompositeStorage.hxx | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/src/storage/CompositeStorage.hxx b/src/storage/CompositeStorage.hxx
index 350cca55d..3ae53738d 100644
--- a/src/storage/CompositeStorage.hxx
+++ b/src/storage/CompositeStorage.hxx
@@ -155,6 +155,14 @@ private:
 		}
 	}
 
+	/**
+	 * Follow the given URI path, and find the outermost directory
+	 * which is a #Storage mount point.  If there are no mounts,
+	 * it returns the root directory (with a nullptr "storage"
+	 * attribute, of course).  FindResult::uri contains the
+	 * remaining unused part of the URI (may be empty if all of
+	 * the URI was used).
+	 */
 	gcc_pure
 	FindResult FindStorage(const char *uri) const;
 	FindResult FindStorage(const char *uri, Error &error) const;