Comment navigation queries

bibiyaya · Nov 26, 2015 · 907eaa5 · 907eaa5
1 parent 5aad8eb
commit 907eaa5
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 8 deletions.
diff --git a/include/vlc_demux.h b/include/vlc_demux.h
@@ -262,13 +262,19 @@ enum demux_query_e
      * arg1= bool * */
     DEMUX_IS_PLAYLIST,
 
-    /* Navigation */
-    DEMUX_NAV_ACTIVATE,        /* res=can fail */
-    DEMUX_NAV_UP,              /* res=can fail */
-    DEMUX_NAV_DOWN,            /* res=can fail */
-    DEMUX_NAV_LEFT,            /* res=can fail */
-    DEMUX_NAV_RIGHT,           /* res=can fail */
-    DEMUX_NAV_POPUP,           /* res=can fail */
+    /* Menu (VCD/DVD/BD) Navigation */
+    /** Activate the navigation item selected. Can fail */
+    DEMUX_NAV_ACTIVATE,
+    /** Use the up arrow to select a navigation item above. Can fail */
+    DEMUX_NAV_UP,
+    /** Use the down arrow to select a navigation item under. Can fail */
+    DEMUX_NAV_DOWN,
+    /** Use the left arrow to select a navigation item on the left. Can fail */
+    DEMUX_NAV_LEFT,
+    /** Use the right arrow to select a navigation item on the right. Can fail */
+    DEMUX_NAV_RIGHT,
+    /** Activate the popup Menu (for BD). Can fail */
+    DEMUX_NAV_POPUP,
 };
 
 /*************************************************************************

diff --git a/include/vlc_input.h b/include/vlc_input.h
@@ -425,12 +425,18 @@ enum input_query_e
     INPUT_GET_SPU_DELAY,        /* arg1 = int* res=can fail */
     INPUT_SET_SPU_DELAY,        /* arg1 = int  res=can fail */
 
-    /* Menu navigation */
+    /* Menu (VCD/DVD/BD) Navigation */
+    /** Activate the navigation item selected. res=can fail */
     INPUT_NAV_ACTIVATE,
+    /** Use the up arrow to select a navigation item above. res=can fail */
     INPUT_NAV_UP,
+    /** Use the down arrow to select a navigation item under. res=can fail */
     INPUT_NAV_DOWN,
+    /** Use the left arrow to select a navigation item on the left. res=can fail */
     INPUT_NAV_LEFT,
+    /** Use the right arrow to select a navigation item on the right. res=can fail */
     INPUT_NAV_RIGHT,
+    /** Activate the popup Menu (for BD). res=can fail */
     INPUT_NAV_POPUP,
 
     /* Meta datas */