search

electro-smith / DaisySP

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

allpass module #46

Closed beserge closed 4 years ago

beserge commented 4 years ago

Brought up to speed with master.

stephenhensley commented 4 years ago

Update the documentation so that it matches doxygen formatting (interestingly this won't register as being documented, and therefore won't throw errors).

check through some of the other files for syntax as necessary, but pretty much 

/** Description

    Any other details

    \param foo array
    \param size number of elements in foo or whatever
    \return a magic spell designed by foo runes
*/
magic_spell create_spell(void* foo, size_t size);
TheSlowGrowth commented 4 years ago

We should eventually enable WARN_AS_ERROR in the doxyfile. Then the check will fail on undocumented code. I had left this off because it would have made the transition to doxygen quite painful. ATM there are a few other warnings that will have to be resolved before we can turn WARN_AS_ERROR on.

stephenhensley commented 4 years ago

@TheSlowGrowth yeah, I figured there was a setting for that in the Doxyfile.

On my dev machines I don't get any warnings from rebuilding docs, but I do see warnings on the CI. Mostly for invalid keys (which I'm guessing is a version discrepancy).

stephenhensley commented 4 years ago

Might sound a bit better with a slower LFO, but no more pop. So that's good.