Mercurial > hg > piper-cpp

diff vamp-support/PreservingPluginOutputIdMapper.h @ 265:7ada63fe1084

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Some neatening
author Chris Cannam <cannam@all-day-breakfast.com>
date Fri, 12 Oct 2018 22:18:37 +0100
parents 427c4c725085
children 4b581a498981
line wrap: on
line diff
--- a/vamp-support/PreservingPluginOutputIdMapper.h	Fri Oct 12 11:12:25 2018 +0100
+++ b/vamp-support/PreservingPluginOutputIdMapper.h	Fri Oct 12 22:18:37 2018 +0100
@@ -41,9 +41,12 @@
 
 namespace piper_vamp {
 
-//!!! document -- this is a passthrough thing that invents its
-//!!! numerical ids, they have no correspondence with any real plugin
-
+/**
+ * A PluginOutputIdMapper that knows nothing about actual plugin IDs,
+ * but that accepts any string as an argument to idToIndex, returns an
+ * entirely invented index that is consistent for that string, and
+ * maps back to the same string through indexToId.
+ */
 class PreservingPluginOutputIdMapper : public PluginOutputIdMapper
 {
 public: