summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorMax Kellermann <max@duempel.org>2016-02-24 00:01:51 +0100
committerMax Kellermann <max@duempel.org>2016-02-24 00:01:51 +0100
commitcfc65397b325088f8fb14e89867311afbfd46ff9 (patch)
tree2cef693ffd2d694ec44fd39b8fc6475d396164ab /src
parentcd8fd1ef427c15561a6f4e88c66ca804a8ab0fe4 (diff)
tag/Generic: clarify documentation on InputStream overload
Diffstat (limited to 'src')
-rw-r--r--src/tag/Generic.hxx3
1 files changed, 2 insertions, 1 deletions
diff --git a/src/tag/Generic.hxx b/src/tag/Generic.hxx
index 36473aa47..0d9f792bf 100644
--- 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);