From 7c9d5ace143d3cc6d767a354acde814926d566fd Mon Sep 17 00:00:00 2001
From: skullydazed <skullydazed@users.noreply.github.com>
Date: Wed, 21 Mar 2018 23:50:38 -0700
Subject: 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
---
 tmk_core/common/eeconfig.c | 56 ++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 56 insertions(+)

(limited to 'tmk_core/common/eeconfig.c')

diff --git a/tmk_core/common/eeconfig.c b/tmk_core/common/eeconfig.c
index e2eb4a38e..91c18e2e6 100644
--- a/tmk_core/common/eeconfig.c
+++ b/tmk_core/common/eeconfig.c
@@ -3,6 +3,10 @@
 #include "eeprom.h"
 #include "eeconfig.h"
 
+/** \brief eeconfig initialization
+ *
+ * FIXME: needs doc
+ */
 void eeconfig_init(void)
 {
     eeprom_update_word(EECONFIG_MAGIC,          EECONFIG_MAGIC_NUMBER);
@@ -24,36 +28,88 @@ void eeconfig_init(void)
 #endif
 }
 
+/** \brief eeconfig enable
+ *
+ * FIXME: needs doc
+ */
 void eeconfig_enable(void)
 {
     eeprom_update_word(EECONFIG_MAGIC, EECONFIG_MAGIC_NUMBER);
 }
 
+/** \brief eeconfig disable
+ *
+ * FIXME: needs doc
+ */
 void eeconfig_disable(void)
 {
     eeprom_update_word(EECONFIG_MAGIC, 0xFFFF);
 }
 
+/** \brief eeconfig is enabled
+ *
+ * FIXME: needs doc
+ */
 bool eeconfig_is_enabled(void)
 {
     return (eeprom_read_word(EECONFIG_MAGIC) == EECONFIG_MAGIC_NUMBER);
 }
 
+/** \brief eeconfig read debug
+ *
+ * FIXME: needs doc
+ */
 uint8_t eeconfig_read_debug(void)      { return eeprom_read_byte(EECONFIG_DEBUG); }
+/** \brief eeconfig update debug
+ *
+ * FIXME: needs doc
+ */
 void eeconfig_update_debug(uint8_t val) { eeprom_update_byte(EECONFIG_DEBUG, val); }
 
+/** \brief eeconfig read default layer
+ *
+ * FIXME: needs doc
+ */
 uint8_t eeconfig_read_default_layer(void)      { return eeprom_read_byte(EECONFIG_DEFAULT_LAYER); }
+/** \brief eeconfig update default layer
+ *
+ * FIXME: needs doc
+ */
 void eeconfig_update_default_layer(uint8_t val) { eeprom_update_byte(EECONFIG_DEFAULT_LAYER, val); }
 
+/** \brief eeconfig read keymap
+ *
+ * FIXME: needs doc
+ */
 uint8_t eeconfig_read_keymap(void)      { return eeprom_read_byte(EECONFIG_KEYMAP); }
+/** \brief eeconfig update keymap
+ *
+ * FIXME: needs doc
+ */
 void eeconfig_update_keymap(uint8_t val) { eeprom_update_byte(EECONFIG_KEYMAP, val); }
 
 #ifdef BACKLIGHT_ENABLE
+/** \brief eeconfig read backlight
+ *
+ * FIXME: needs doc
+ */
 uint8_t eeconfig_read_backlight(void)      { return eeprom_read_byte(EECONFIG_BACKLIGHT); }
+/** \brief eeconfig update backlight
+ *
+ * FIXME: needs doc
+ */
 void eeconfig_update_backlight(uint8_t val) { eeprom_update_byte(EECONFIG_BACKLIGHT, val); }
 #endif
 
 #ifdef AUDIO_ENABLE
+/** \brief eeconfig read audio
+ *
+ * FIXME: needs doc
+ */
 uint8_t eeconfig_read_audio(void)      { return eeprom_read_byte(EECONFIG_AUDIO); }
+/** \brief eeconfig update audio
+ *
+ * FIXME: needs doc
+ */
 void eeconfig_update_audio(uint8_t val) { eeprom_update_byte(EECONFIG_AUDIO, val); }
 #endif
-- 
cgit v1.2.3