summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDave Davenport <qball@gmpclient.org>2019-09-30 10:35:12 +0200
committerDave Davenport <qball@gmpclient.org>2019-09-30 10:35:12 +0200
commit0a0556c76571e9fcec68de7dcf8a60369cf746e2 (patch)
tree8264c92e95a02444f92937d905abc32325ef7210
parent3def8a64182f74902d95f92f118187becd314698 (diff)
[CI] Update missing documentation.
-rw-r--r--include/settings.h3
-rw-r--r--include/theme.h28
-rw-r--r--source/dialogs/ssh.c6
-rw-r--r--source/timings.c7
-rw-r--r--source/widgets/listview.c6
5 files changed, 46 insertions, 4 deletions
diff --git a/include/settings.h b/include/settings.h
index 14940d97..0c575f19 100644
--- a/include/settings.h
+++ b/include/settings.h
@@ -43,6 +43,9 @@ typedef enum
MM_FUZZY = 3
} MatchingMethod;
+/**
+ * Possible sorting methods for listview.
+ */
typedef enum
{
SORT_NORMAL = 0,
diff --git a/include/theme.h b/include/theme.h
index e8c98810..496c2626 100644
--- a/include/theme.h
+++ b/include/theme.h
@@ -32,19 +32,31 @@
#include <widgets/widget.h>
#include "rofi-types.h"
-
+/**
+ * Describe the media constraint type.
+ */
typedef enum {
+ /** Minimum width constraint. */
THEME_MEDIA_TYPE_MIN_WIDTH,
+ /** Maximum width constraint. */
THEME_MEDIA_TYPE_MAX_WIDTH,
+ /** Minimum height constraint. */
THEME_MEDIA_TYPE_MIN_HEIGHT,
+ /** Maximum height constraint. */
THEME_MEDIA_TYPE_MAX_HEIGHT,
+ /** Monitor id constraint. */
THEME_MEDIA_TYPE_MON_ID,
+ /** Minimum aspect ratio constraint. */
THEME_MEDIA_TYPE_MIN_ASPECT_RATIO,
+ /** Maximum aspect ratio constraint. */
THEME_MEDIA_TYPE_MAX_ASPECT_RATIO,
+ /** Invalid entry. */
THEME_MEDIA_TYPE_INVALID,
} ThemeMediaType;
-
+/**
+ * Theme Media description.
+ */
typedef struct ThemeMedia {
ThemeMediaType type;
double value;
@@ -348,6 +360,18 @@ char * rofi_theme_parse_prepare_file ( const char *file, const char *parent_file
* Process conditionals.
*/
void rofi_theme_parse_process_conditionals ( void );
+
+/**
+ * @parent Target theme tree
+ * @parent child source theme three
+ *
+ * Merge all the settings from child into parent.
+ */
void rofi_theme_parse_merge_widgets ( ThemeWidget *parent, ThemeWidget *child );
+/**
+ * @type the media type to parse.
+ *
+ * Returns the media type described by type.
+ */
ThemeMediaType rofi_theme_parse_media_type ( const char *type );
#endif
diff --git a/source/dialogs/ssh.c b/source/dialogs/ssh.c
index bb2eea20..d6341a94 100644
--- a/source/dialogs/ssh.c
+++ b/source/dialogs/ssh.c
@@ -56,9 +56,13 @@
#include "history.h"
#include "dialogs/ssh.h"
-
+/**
+ * Holding an ssh entry.
+ */
typedef struct _SshEntry {
+ /** SSH hostname */
char *hostname;
+ /** SSH port number */
int port;
} SshEntry;
/**
diff --git a/source/timings.c b/source/timings.c
index 9f882080..a5fedc7b 100644
--- a/source/timings.c
+++ b/source/timings.c
@@ -25,13 +25,20 @@
*
*/
+/** Log domain used by timings.*/
#define G_LOG_DOMAIN "Timings"
#include "config.h"
#include <stdio.h>
#include "rofi.h"
#include "timings.h"
+/**
+ * Timer used to calculate time stamps.
+ */
GTimer *global_timer = NULL;
+/**
+ * Last timestamp made.
+ */
double global_timer_last = 0.0;
void rofi_timings_init ( void )
diff --git a/source/widgets/listview.c b/source/widgets/listview.c
index 9ba45d6d..7609bb11 100644
--- a/source/widgets/listview.c
+++ b/source/widgets/listview.c
@@ -127,7 +127,11 @@ struct _listview
unsigned int cur_visible;
} barview;
};
-
+/**
+ * Names used for theming the elements in the listview.
+ * Each row can have 3 modes, normal, selected and alternate.
+ * Each row can have 3 states, normal, urgent and active.
+ */
const char *const listview_theme_prop_names[][3] = {
/** Normal row */
{ "normal.normal", "selected.normal", "alternate.normal" },