From cef086988d270868e66a29752c0c8728950d13e7 Mon Sep 17 00:00:00 2001
From: twinaphex <libretro@gmail.com>
Date: Mon, 12 Jan 2015 03:20:21 +0100
Subject: [PATCH] Documents descend_alphabet/ascend_alphabet

---
 menu/menu_navigation.c | 22 ++++++++++++++++++++++
 menu/menu_navigation.h | 22 ++++++++++++++++++++++
 2 files changed, 44 insertions(+)

diff --git a/menu/menu_navigation.c b/menu/menu_navigation.c
index cbde42f1a2..14d2907f6a 100644
--- a/menu/menu_navigation.c
+++ b/menu/menu_navigation.c
@@ -95,6 +95,17 @@ void menu_navigation_set_last(menu_handle_t *menu)
       driver.menu_ctx->navigation_set_last(menu);
 }
 
+/**
+ * menu_navigation_descend_alphabet:
+ * @menu                  : menu handle
+ * @ptr_out               : Amount of indices to 'scroll' to get
+ *                          to the next entry.
+ *
+ * Descends alphabet.
+ * E.g.:
+ * If navigation points to an entry called 'Beta',
+ * navigation pointer will be set to an entry called 'Alpha'.
+ **/
 void menu_navigation_descend_alphabet(menu_handle_t *menu, size_t *ptr_out)
 {
    size_t i   = 0;
@@ -116,6 +127,17 @@ void menu_navigation_descend_alphabet(menu_handle_t *menu, size_t *ptr_out)
       driver.menu_ctx->navigation_descend_alphabet(menu, ptr_out);
 }
 
+/**
+ * menu_navigation_ascends_alphabet:
+ * @menu                  : menu handle
+ * @ptr_out               : Amount of indices to 'scroll' to get
+ *                          to the next entry.
+ *
+ * Ascends alphabet.
+ * E.g.:
+ * If navigation points to an entry called 'Alpha',
+ * navigation pointer will be set to an entry called 'Beta'.
+ **/
 void menu_navigation_ascend_alphabet(menu_handle_t *menu, size_t *ptr_out)
 {
    size_t i   = 0;
diff --git a/menu/menu_navigation.h b/menu/menu_navigation.h
index ce39214742..5222a46154 100644
--- a/menu/menu_navigation.h
+++ b/menu/menu_navigation.h
@@ -66,8 +66,30 @@ void menu_navigation_set(menu_handle_t *menu, size_t i, bool scroll);
  **/
 void menu_navigation_set_last(menu_handle_t *menu);
 
+/**
+ * menu_navigation_descend_alphabet:
+ * @menu                  : menu handle
+ * @ptr_out               : Amount of indices to 'scroll' to get
+ *                          to the next entry.
+ *
+ * Descends alphabet.
+ * E.g.:
+ * If navigation points to an entry called 'Beta',
+ * navigation pointer will be set to an entry called 'Alpha'.
+ **/
 void menu_navigation_descend_alphabet(menu_handle_t *menu, size_t *ptr_out);
 
+/**
+ * menu_navigation_ascends_alphabet:
+ * @menu                  : menu handle
+ * @ptr_out               : Amount of indices to 'scroll' to get
+ *                          to the next entry.
+ *
+ * Ascends alphabet.
+ * E.g.:
+ * If navigation points to an entry called 'Alpha',
+ * navigation pointer will be set to an entry called 'Beta'.
+ **/
 void menu_navigation_ascend_alphabet(menu_handle_t *menu, size_t *ptr_out);
 
 #ifdef __cplusplus