TagFile: add return value API documentation

2013-12-10 19:32:26 +01:00 · 2013-12-10 19:32:26 +01:00 · 39d94bd3ea
parent 695ca29274
commit 39d94bd3ea
1 changed files with 3 additions and 0 deletions
--- 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,