Some documentation tweaks
zephyrr opened this issue · comments
Quick notes on Doxygen docs:
In the Constructor, the note might say "radioNum is only needed..."
broadcast seems kind of oddly named (turns OFF broadcasting except for 255)
Example for setVolume uses .volume()
Overall, really cool project!
For some reason I find this really funny. The broadcast() name is one of those things that bugged me and I actually renamed it a few times during development. I think it was called privateBroadcast first, then something else, then I just called it broadcast, since it is different than transmit, but can redirect a stream to any radio or group of radios. Got any suggestions?
Also I will fix the other stuff, thanks!.
Maybe "destination()"? with a number for the destination node, or 255 for broadcast?
Might want to define a constant for the broadcast value, just in case you wanted to change it.
Hmm, I'm not sure destination is that much better, but is maybe more intuitive. I keep thinking there has got to be a better word/word combo for it.
Adding it as a constant goes against my minimalist nature, but is probably the 'correct' thing to do so I'll go along with that, although begrudgingly.
@TMRh20 do you have a copy of the doxyfile for this repo? it doesn't seem to be in the repo (unless I'm missing it somewhere)
Added