tag/Generic: clarify documentation on InputStream overload

2016-02-24 00:01:51 +01:00
parent cd8fd1ef42
commit cfc65397b3
1 changed files with 2 additions and 1 deletions
--- a/src/tag/Generic.hxx
+++ b/src/tag/Generic.hxx
@@ -27,7 +27,8 @@ class InputStream;
 class Path;

 /**
- * Attempts to scan APE or ID3 tags from the specified file.
+ * Attempts to scan APE or ID3 tags from the specified stream.  The
+ * stream does not need to be rewound.
 */
 bool
 ScanGenericTags(InputStream &is, const TagHandler &handler, void *ctx);