Add documentation for the LEDControl plugin #1405
Conversation
Signed-off-by: Evy Bongers <[email protected]>
EvyBongers
force-pushed
the
docs/LEDControl
branch
from
0802d6f to
1714765
Compare
Signed-off-by: Evy Bongers <[email protected]>
|
|
||
| > See [[event-handler-hooks]] | ||
|
|
||
| ### `.setup(void)` |
There was a problem hiding this comment.
I'm not sure how to explain this one. I half expect it to be documented elsewhere and that I should refer to that, but I failed to find it.
| > Triggers the currently active LED mode to refresh the LED at the specified key | ||
| > address. | ||
|
|
||
| ### `.activate(LEDModeInterface *plugin)` |
There was a problem hiding this comment.
I was about to write something along the lines of "Activates the specified LED mode." However, that would not prevent the judgement error recently pointed out to me that this actually invokes and depends on PROGMEM and/or EEPROM.
|
Thank you so much for working on this. I do so wish that we had a decent way for method-level docs to live next to the methods they're documenting and to generate pretty looking readable docs. |
|
Doxygen can't do that? |
|
It can, if we can get it configured sanely. The last time I tried (which
was, admittedly, pre-COVID), it was a *mess* that generated something
totally unintelligible
…On Tue, Mar 12, 2024 at 11:43 AM Evy Bongers ***@***.***> wrote:
Doxygen can't do that?
https://www.doxygen.nl/manual/docblocks.html
—
Reply to this email directly, view it on GitHub
<#1405 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AAALC2GS5ORETR7YULZ5BHTYX5EELAVCNFSM6AAAAABELXGR4OVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTSOJSGMYTQNZYGM>
.
You are receiving this because you commented.Message ID:
***@***.***>
|
Signed-off-by: Evy Bongers <[email protected]>
|
|
||
| > Returns the current LED mode. | ||
|
|
||
| ### `.get_mode<typename>()` |
There was a problem hiding this comment.
I don't know how to properly explain this. Having looked at the commit you mentioned on discord I understand what it does, but I don't know the words to explain it.
Signed-off-by: Evy Bongers <[email protected]>
|
This is the best I can do at this time |
|
This is great. Thanks! |
* Get started with LEDControl documentation * Add documentation for a number of methods Signed-off-by: Evy Bongers <[email protected]>
No description provided.