From 39d94bd3ea9e7c457f5a30bc3b4017f3d63294e5 Mon Sep 17 00:00:00 2001
From: Max Kellermann <max@duempel.org>
Date: Tue, 10 Dec 2013 19:32:26 +0100
Subject: TagFile: add return value API documentation

---
 src/TagFile.hxx | 3 +++
 1 file changed, 3 insertions(+)

(limited to 'src')

diff --git a/src/TagFile.hxx b/src/TagFile.hxx
index 3a49a04e1..078abebd9 100644
--- a/src/TagFile.hxx
+++ b/src/TagFile.hxx
@@ -28,6 +28,9 @@ struct tag_handler;
 /**
  * Scan the tags of a song file.  Invokes matching decoder plugins,
  * but does not invoke the special "APE" and "ID3" scanners.
+ *
+ * @return true if the file was recognized (even if no metadata was
+ * found)
  */
 bool
 tag_file_scan(Path path,
-- 
cgit v1.2.3