Ringbuffer class missing from API documentation?

ska-sa / spead2

Library for the Streaming Protocol for Exchange of Astronomical Data (SPEAD)

http://spead2.readthedocs.io/en/latest/

GNU Lesser General Public License v3.0

23 stars 13 forks source link

Ringbuffer class missing from API documentation? #138

Open james-smith-za opened 3 years ago

james-smith-za commented 3 years ago

https://github.com/ska-sa/spead2/blob/15124378872b3b79599c0ae1a84dddbe2eae5851/include/spead2/common_ringbuffer.h#L262-L285

I wasn't able to find this class documented anywhere on readthedocs. Was that by design?

bmerry commented 3 years ago

Probably just because I haven't put a lot of effort into the C++ docs. It's not needed by everybody because it's normally hidden behind spead2::recv::ring_stream.

james-smith-za commented 3 years ago

Good point. I came looking for it because of how it gets used in kafgpu, and I couldn't find anything in readthedocs. The documentation in the code was what I needed, but I just thought it was weird that Sphinx didn't include it.

bmerry commented 3 years ago

We can leave this bug open - one day I should get around to improving the C++ docs on readthedocs.