From 9909fb3d7108c2cea200848d3e2a766f46be2f3b Mon Sep 17 00:00:00 2001
From: Dave Davenport <qball@gmpclient.org>
Date: Tue, 12 Jun 2018 14:11:08 +0200
Subject: [PATCH] More documentation fixes

---
 source/rofi-icon-fetcher.c | 3 +++
 source/view.c              | 7 +++++++
 source/widgets/listview.c  | 9 +++++++++
 source/widgets/scrollbar.c | 1 +
 source/xcb.c               | 6 ++++--
 5 files changed, 24 insertions(+), 2 deletions(-)

diff --git a/source/rofi-icon-fetcher.c b/source/rofi-icon-fetcher.c
index 050b717c..94e3bb8c 100644
--- a/source/rofi-icon-fetcher.c
+++ b/source/rofi-icon-fetcher.c
@@ -72,6 +72,9 @@ typedef struct {
     IconFetcherNameEntry *entry;
 } IconFetcherEntry;
 
+/**
+ * The icon fetcher internal state.
+ */
 IconFetcher *rofi_icon_fetcher_data = NULL;
 
 
diff --git a/source/view.c b/source/view.c
index 5605f878..0a67893a 100644
--- a/source/view.c
+++ b/source/view.c
@@ -1431,6 +1431,10 @@ void rofi_view_maybe_update ( RofiViewState *state )
     rofi_view_update ( state, TRUE );
 }
 
+/**
+ * Handle window configure event.
+ * Handles resizes.
+ */
 void rofi_view_temp_configure_notify ( RofiViewState *state, xcb_configure_notify_event_t *xce )
 {
     if ( xce->window == CacheState.main_window ) {
@@ -1459,6 +1463,9 @@ void rofi_view_temp_configure_notify ( RofiViewState *state, xcb_configure_notif
     }
 }
 
+/**
+ * Quit rofi on click (outside of view )
+ */
 void rofi_view_temp_click_to_exit ( RofiViewState *state, xcb_window_t target )
 {
     if ( ( CacheState.flags & MENU_NORMAL_WINDOW ) == 0 ) {
diff --git a/source/widgets/listview.c b/source/widgets/listview.c
index 6705cbed..b9dfefd7 100644
--- a/source/widgets/listview.c
+++ b/source/widgets/listview.c
@@ -35,14 +35,23 @@
 #include "settings.h"
 #include "theme.h"
 
+/** Default spacing between the elements in the listview. */
 #define DEFAULT_SPACING    2
 
+/**
+ * Orientation of the listview
+ */
 typedef enum
 {
+    /** Vertical (classical) list */
     LISTVIEW = ROFI_ORIENTATION_VERTICAL,
+    /** Horizontal list. (barview) */
     BARVIEW  = ROFI_ORIENTATION_HORIZONTAL,
 } ViewType;
 
+/**
+ * The moving direction of the selection, this (in barview) affects the scrolling.
+ */
 typedef enum
 {
     LEFT_TO_RIGHT = 0,
diff --git a/source/widgets/scrollbar.c b/source/widgets/scrollbar.c
index 80fcbf7f..d3400593 100644
--- a/source/widgets/scrollbar.c
+++ b/source/widgets/scrollbar.c
@@ -34,6 +34,7 @@
 
 #include "theme.h"
 
+/** The default width of the scrollbar */
 #define DEFAULT_SCROLLBAR_WIDTH    8
 
 static void scrollbar_draw ( widget *, cairo_t * );
diff --git a/source/xcb.c b/source/xcb.c
index 2d8069c9..da2425af 100644
--- a/source/xcb.c
+++ b/source/xcb.c
@@ -49,8 +49,9 @@
 #include <xcb/xkb.h>
 #include <xkbcommon/xkbcommon.h>
 #include <xkbcommon/xkbcommon-x11.h>
+/** Indicate that we know the startup notification api is not yet stable. */
 #define SN_API_NOT_YET_FROZEN
-/* This function is declared as sn_launcher_context_set_application_id but implemented as sn_launcher_set_application_id */
+/** This function is declared as sn_launcher_context_set_application_id but implemented as sn_launcher_set_application_id. Quick Fix. */
 #define sn_launcher_context_set_application_id    sn_launcher_set_application_id
 #include "rofi-types.h"
 #include <libsn/sn.h>
@@ -63,8 +64,9 @@
 
 #include <rofi.h>
 
-/** Minimal randr prefered for running rofi (1.5) */
+/** Minimal randr prefered for running rofi (1.5) (Major version number) */
 #define RANDR_PREF_MAJOR_VERSION 1
+/** Minimal randr prefered for running rofi (1.5) (Minor version number) */
 #define RANDR_PREF_MINOR_VERSION 5
 
 /** Checks if the if x and y is inside rectangle. */