From b93155c46029b89bdfda49cf339140fc5939a17f Mon Sep 17 00:00:00 2001
From: Kris Nuttycombe <kris@nutty.land>
Date: Tue, 25 Jan 2022 09:15:51 -0700
Subject: [PATCH] Add documentation for
 `UnifiedAddress::GetPreferredRecipientAddress`

---
 src/zcash/Address.hpp | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/src/zcash/Address.hpp b/src/zcash/Address.hpp
index 76c11f646..f093b8cb7 100644
--- a/src/zcash/Address.hpp
+++ b/src/zcash/Address.hpp
@@ -154,6 +154,10 @@ public:
 
     std::optional<SaplingPaymentAddress> GetSaplingReceiver() const;
 
+    /**
+     * Return the most-preferred receiver from among the receiver types
+     * that we recognize.
+     */
     std::optional<RecipientAddress> GetPreferredRecipientAddress() const;
 
     friend inline bool operator==(const UnifiedAddress& a, const UnifiedAddress& b) {