From 0a0556c76571e9fcec68de7dcf8a60369cf746e2 Mon Sep 17 00:00:00 2001 From: Dave Davenport Date: Mon, 30 Sep 2019 10:35:12 +0200 Subject: [CI] Update missing documentation. --- include/settings.h | 3 +++ include/theme.h | 28 ++++++++++++++++++++++++++-- 2 files changed, 29 insertions(+), 2 deletions(-) (limited to 'include') 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 #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 -- cgit v1.2.3