From dd914fcdcf041671e90760682bf5246490085b3c Mon Sep 17 00:00:00 2001
From: Kris Nuttycombe <kris@electriccoin.co>
Date: Tue, 23 Mar 2021 19:42:45 -0600
Subject: [PATCH] Document FeatureSet type.

---
 src/consensus/params.h | 15 +++++++++++----
 1 file changed, 11 insertions(+), 4 deletions(-)

diff --git a/src/consensus/params.h b/src/consensus/params.h
index 8c86ec7a2..c8929e285 100644
--- a/src/consensus/params.h
+++ b/src/consensus/params.h
@@ -153,6 +153,16 @@ struct FeatureInfo {
     UpgradeIndex activation;
 };
 
+/**
+ * A FeatureSet encodes a directed acyclic graph of feature dependencies
+ * as an array indexed by feature ID. Values are FeatureInfo objects
+ * containing the list of feature IDs upon which the index's feature ID
+ * depends.
+ *
+ * The `Feature` and `Params` template parameters permit for the
+ * logic of `FeatureActive` to be tested against a mock set of
+ * features and activation heights.
+ */
 template <class Feature, class Params>
 class FeatureSet {
 private:
@@ -191,10 +201,7 @@ public:
 };
 
 /**
- * Features encodes a directed acyclic graph of feature dependencies
- * as an array indexed by feature ID. Values are FeatureInfo objects
- * containing the list of feature IDs upon which the index's feature ID
- * depends.
+ * The set of features supported by Zcashd.
  */
 const FeatureSet<ConsensusFeature, Params> Features({});