search

electro-smith / DaisySP

A Powerful DSP Library in C++
https://www.electro-smith.com/daisy
Other
903 stars 143 forks source link

@see AdEnvSegment from AdEnv #193

Open keatonuw opened 1 year ago

keatonuw commented 1 year ago

As a user of DaisySP, it was unclear what integers were valid inputs and outputs from AdEnv::SetTime and AdEnv::GetCurrentSegment.

I've added @see AdEnvSegment comments to AdEnv documentation. This should help future developers quickly find the enumeration through the documentation.

FYI: This is my first PR on GitHub & first contribution to DaisySP! I've read the contribution guides, but let me know if I'm missing anything. Thanks!

beserge commented 11 months ago

Nice catch! My preference is actually to change it so that AdEnvSegment would be a member of AdEnv, and then the seg argument would be of type AdEnvSegment i.e. SetTime(AdEnvSegment seg, float time)

I would think that would also fix the documentation issue automatically, though I will check that to make sure. I'm going to make that change and close this PR soon (we're saving any breaking changes for a little while).

Thanks again for the catch!