tag/Generic: clarify documentation on InputStream overload

cfc65397 · Max Kellermann · cd8fd1ef · cfc65397
Commit cfc65397 authored Feb 24, 2016 by Max Kellermann
Show whitespace changes
Inline Side-by-side

Showing with 2 additions and 1 deletion

Generic.hxx src/tag/Generic.hxx +2 -1

No files found.
--- 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);