Documentation missing or incomplete for many API/doc sections.

jgaeddert / liquid-dsp

digital signal processing library for software-defined radios

http://liquidsdr.org

MIT License

1.82k stars 426 forks source link

Documentation missing or incomplete for many API/doc sections. #327

Open remy-luisant opened 1 year ago

remy-luisant commented 1 year ago

I have noticed that the website does not have the qdetector documented. There are others, too. Multichannel comes to mind.

I will not give the whole list here. Suffice to say, this has been a grave problem in quickly moving around the library. (I no longer need the details on the two, I'm merely reporting the lack of documentation as a former impediment.)

The problem spans both the doc and the api tabs. The two are also drifting out of sync with each other, it seems.

jgaeddert commented 1 year ago

Fair point, and I've been (slowly) trying to synchronize them and complete missing pieces. I can prioritize the qdetector object and multichannel module.