summaryrefslogtreecommitdiff
path: root/src/tag
diff options
context:
space:
mode:
authorMax Kellermann <max@musicpd.org>2019-03-15 19:23:10 +0100
committerMax Kellermann <max@musicpd.org>2019-03-15 19:23:10 +0100
commit8d1f30e55b107b1b96eedf26b2df0cd3622da0b1 (patch)
tree3f32dbabfeb7184ddb454c254598e6d85fc91c56 /src/tag
parentddd2b604890db0c7afcdd8377e551d34fae0d03d (diff)
tag/Fallback: add API documentation
Diffstat (limited to 'src/tag')
-rw-r--r--src/tag/Fallback.hxx10
1 files changed, 10 insertions, 0 deletions
diff --git a/src/tag/Fallback.hxx b/src/tag/Fallback.hxx
index 08e4dc80a..ecbe0d439 100644
--- a/src/tag/Fallback.hxx
+++ b/src/tag/Fallback.hxx
@@ -22,6 +22,11 @@
#include <utility>
+/**
+ * Invoke the given function for all fallback tags of the given
+ * #TagType, until the function returns true (or until there are no
+ * more fallback tags).
+ */
template<typename F>
bool
ApplyTagFallback(TagType type, F &&f) noexcept
@@ -43,6 +48,11 @@ ApplyTagFallback(TagType type, F &&f) noexcept
return false;
}
+/**
+ * Invoke the given function for the given #TagType and all of its
+ * fallback tags, until the function returns true (or until there are
+ * no more fallback tags).
+ */
template<typename F>
bool
ApplyTagWithFallback(TagType type, F &&f) noexcept