From 507a13b49f613668f91d93417153a57f027398b6 Mon Sep 17 00:00:00 2001 From: Rahix <rahix@rahix.de> Date: Sun, 4 Aug 2019 22:25:00 +0200 Subject: [PATCH] docs: Mark epic_leds_set() as not yet stable Signed-off-by: Rahix <rahix@rahix.de> --- epicardium/epicardium.h | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/epicardium/epicardium.h b/epicardium/epicardium.h index 1cc36d58..34af173e 100644 --- a/epicardium/epicardium.h +++ b/epicardium/epicardium.h @@ -213,6 +213,13 @@ API_ISR(EPIC_INT_CTRL_C, epic_isr_ctrl_c); /** * Set one of card10's RGB LEDs to a certain color. * + * .. warning:: + * + * This API function is not yet stable and is this not part of the API + * freeze. Any binary using :c:func:`epic_leds_set` might stop working at + * any time. Once this warning is removed, the function can be considered + * stable like the rest of the API. + * * :param led: Which led to set. 0-10 are the leds on the top and 11-14 are the 4 "ambient" leds. * :param r: Red component of the color. * :param g: Green component of the color. -- GitLab