summaryrefslogtreecommitdiff
path: root/src/TagFile.hxx
diff options
context:
space:
mode:
authorMax Kellermann <max@duempel.org>2013-12-10 19:32:26 +0100
committerMax Kellermann <max@duempel.org>2013-12-10 19:32:26 +0100
commit39d94bd3ea9e7c457f5a30bc3b4017f3d63294e5 (patch)
tree559c042f90a5a4b6455f7a3dc276a1f4f21ef1e6 /src/TagFile.hxx
parent695ca292742a1d09d9bf9c56cea50ac954383914 (diff)
TagFile: add return value API documentation
Diffstat (limited to 'src/TagFile.hxx')
-rw-r--r--src/TagFile.hxx3
1 files changed, 3 insertions, 0 deletions
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,