From b4c599f022feb69d5be7c27a3037c70c02c44790 Mon Sep 17 00:00:00 2001
From: Dave Davenport <qball@gmpclient.org>
Date: Fri, 14 Oct 2016 08:47:21 +0200
Subject: Add more documentation.

Current state: 61% coverage.
---
 include/view-internal.h | 51 ++++++++++++++++++++++++++++++++++---------------
 1 file changed, 36 insertions(+), 15 deletions(-)

(limited to 'include/view-internal.h')

diff --git a/include/view-internal.h b/include/view-internal.h
index 1145006e..34e333e5 100644
--- a/include/view-internal.h
+++ b/include/view-internal.h
@@ -17,63 +17,84 @@
 
 struct RofiViewState
 {
+    /** #Mode bound to to this view. */
     Mode             *sw;
 
-    // Update/Refilter list.
+    /** Flag indicating if view needs to be refiltered. */
     int              refilter;
-    int              rchanged;
 
+    /** Main #box widget holding different elements. */
     box              *main_box;
-    // Entries
+    /** #box widget packing the input bar widgets. */
     box              *input_bar;
-    separator        *input_bar_separator;
-
+    /** #textbox showing the prompt in the input bar. */
     textbox          *prompt;
+    /** #textbox with the user input in the input bar. */
     textbox          *text;
+    /** #textbox showing the state of the case sensitive and sortng. */
     textbox          *case_indicator;
+    /** #separator widget below the input bar. */
+    separator        *input_bar_separator;
 
+    /** #listview holding the displayed elements. */
     listview         *list_view;
-    // Small overlay.
+    /** #textbox widget showing the overlay. */
     textbox          *overlay;
+    /** Array with the levenshtein distance for each eleemnt. */
     int              *distance;
+    /** Array with the translation between the filtered and unfiltered list. */
     unsigned int     *line_map;
-
+    /** number of (unfiltered) elements to show. */
     unsigned int     num_lines;
 
-    // Selected element.
+    /** number of (filtered) elements to show. */
     unsigned int     filtered_lines;
-    // Last offset in paginating.
-    unsigned int     last_offset;
 
+    /** Previously called key action. */
     KeyBindingAction prev_action;
+    /** Time previous key action was executed. */
     xcb_timestamp_t  last_button_press;
 
+    /** Indicate view should terminate */
     int              quit;
+    /** Indicate if we should absorb the key release */
     int              skip_absorb;
-    // Return state
+    /** The selected line (in the unfiltered list) */
     unsigned int     selected_line;
+    /** The return state of the view */
     MenuReturn       retv;
+    /** Calculated border width */
     unsigned int     border;
+    /** Monitor #workarea the view is displayed on */
     workarea         mon;
 
-    // Sidebar view
+    /** #box holding the different modi buttons */
     box              *sidebar_bar;
+    /** number of modi to display */
     unsigned int     num_modi;
+    /** Array of #textbox that act as buttons for switching modi */
     textbox          **modi;
-
+    /** Settings of the menu */
     MenuFlags        menu_flags;
+    /** If mouse was within view previously */
     int              mouse_seen;
-
+    /** Flag indicating if view needs to be reloaded. */
     int              reload;
-    // Handlers.
+    /** X11 event loop to be called for this view. */
     void             ( *x11_event_loop )( struct RofiViewState *state, xcb_generic_event_t *ev, xkb_stuff *xkb );
+    /** The funciton to be called when finalizing this view */
     void             ( *finalize )( struct RofiViewState *state );
 
+    /** Width of the view */
     int              width;
+    /** Height of the view */
     int              height;
+    /** X position of the view */
     int              x;
+    /** Y position of the view */
     int              y;
 
+    /** Regexs used for matching */
     GRegex           **tokens;
 };
 /** @} */
-- 
cgit v1.2.3