summaryrefslogtreecommitdiffstats
path: root/tmk_core/common/backlight.c
diff options
context:
space:
mode:
authorskullydazed <skullydazed@users.noreply.github.com>2018-03-21 23:50:38 -0700
committerJack Humbert <jack.humb@gmail.com>2018-03-22 02:50:38 -0400
commit7c9d5ace143d3cc6d767a354acde814926d566fd (patch)
tree1f2b581b6c9f6278a9e180bfcc8dd86b0a7fd2ef /tmk_core/common/backlight.c
parentf0932a8716dc946322c5ebae7f75eaa275c6220c (diff)
Generate API docs from source code comments (#2491)
* Generate api docs from source code * Add a bunch of doxygen comments * more doxygen comments * Add the in-progress api docs * script to generate docs from travis * Add doc generation to the travis job * make travis_docs.sh commit the work it does * make sure the docs script exits cleanly
Diffstat (limited to 'tmk_core/common/backlight.c')
-rw-r--r--tmk_core/common/backlight.c28
1 files changed, 28 insertions, 0 deletions
diff --git a/tmk_core/common/backlight.c b/tmk_core/common/backlight.c
index 12f75b38ac..3e29aacc49 100644
--- a/tmk_core/common/backlight.c
+++ b/tmk_core/common/backlight.c
@@ -21,6 +21,10 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
backlight_config_t backlight_config;
+/** \brief Backlight initialization
+ *
+ * FIXME: needs doc
+ */
void backlight_init(void)
{
/* check signature */
@@ -34,6 +38,10 @@ void backlight_init(void)
backlight_set(backlight_config.enable ? backlight_config.level : 0);
}
+/** \brief Backlight increase
+ *
+ * FIXME: needs doc
+ */
void backlight_increase(void)
{
if(backlight_config.level < BACKLIGHT_LEVELS)
@@ -46,6 +54,10 @@ void backlight_increase(void)
backlight_set(backlight_config.level);
}
+/** \brief Backlight decrease
+ *
+ * FIXME: needs doc
+ */
void backlight_decrease(void)
{
if(backlight_config.level > 0)
@@ -58,6 +70,10 @@ void backlight_decrease(void)
backlight_set(backlight_config.level);
}
+/** \brief Backlight toggle
+ *
+ * FIXME: needs doc
+ */
void backlight_toggle(void)
{
backlight_config.enable ^= 1;
@@ -68,6 +84,10 @@ void backlight_toggle(void)
backlight_set(backlight_config.enable ? backlight_config.level : 0);
}
+/** \brief Backlight step through levels
+ *
+ * FIXME: needs doc
+ */
void backlight_step(void)
{
backlight_config.level++;
@@ -81,6 +101,10 @@ void backlight_step(void)
backlight_set(backlight_config.level);
}
+/** \brief Backlight set level
+ *
+ * FIXME: needs doc
+ */
void backlight_level(uint8_t level)
{
if (level > BACKLIGHT_LEVELS)
@@ -91,6 +115,10 @@ void backlight_level(uint8_t level)
backlight_set(backlight_config.level);
}
+/** \brief Get backlight level
+ *
+ * FIXME: needs doc
+ */
uint8_t get_backlight_level(void)
{
return backlight_config.level;