From 37641fd60319d0409901cb51f914a198431631e1 Mon Sep 17 00:00:00 2001
From: keatonuw <keatonkowal@icloud.com>
Date: Wed, 11 Oct 2023 10:50:34 -0700
Subject: [PATCH] Added @see AdEnvSegment comments to AdEnv documentation

---
 Source/Control/adenv.h | 10 +++++++++-
 1 file changed, 9 insertions(+), 1 deletion(-)

diff --git a/Source/Control/adenv.h b/Source/Control/adenv.h
index 46e21b1f..26d12e63 100644
--- a/Source/Control/adenv.h
+++ b/Source/Control/adenv.h
@@ -54,7 +54,11 @@ class AdEnv
 
     /** Starts or retriggers the envelope.*/
     inline void Trigger() { trigger_ = 1; }
-    /** Sets the length of time (in seconds) for a specific segment. */
+    /** Sets the length of time (in seconds) for a specific segment.
+        
+        Segments are defined by the AdEnvSegment enumeration.
+        @see AdEnvSegment
+    */
     inline void SetTime(uint8_t seg, float time) { segment_time_[seg] = time; }
     /** Sets the amount of curve applied. A positve value will create a log
         curve. Input range: -100 to 100.  (or more)
@@ -72,6 +76,10 @@ class AdEnv
     inline float GetValue() const { return (output_ * (max_ - min_)) + min_; }
     /** Returns the segment of the envelope that the phase is currently located
         in.
+        
+        Segments are defined by the AdEnvSegment enumeration.
+        @see AdEnvSegment
+        \return the current AdEnvSegment
     */
     inline uint8_t GetCurrentSegment() { return current_segment_; }
     /** Returns true if the envelope is currently in any stage apart from idle.