1
0
Fork 0
mirror of https://github.com/davatorium/rofi.git synced 2024-11-18 13:54:36 -05:00

[CI] Update missing documentation.

This commit is contained in:
Dave Davenport 2019-09-30 10:35:12 +02:00
parent 3def8a6418
commit 0a0556c765
5 changed files with 46 additions and 4 deletions

View file

@ -43,6 +43,9 @@ typedef enum
MM_FUZZY = 3 MM_FUZZY = 3
} MatchingMethod; } MatchingMethod;
/**
* Possible sorting methods for listview.
*/
typedef enum typedef enum
{ {
SORT_NORMAL = 0, SORT_NORMAL = 0,

View file

@ -32,19 +32,31 @@
#include <widgets/widget.h> #include <widgets/widget.h>
#include "rofi-types.h" #include "rofi-types.h"
/**
* Describe the media constraint type.
*/
typedef enum { typedef enum {
/** Minimum width constraint. */
THEME_MEDIA_TYPE_MIN_WIDTH, THEME_MEDIA_TYPE_MIN_WIDTH,
/** Maximum width constraint. */
THEME_MEDIA_TYPE_MAX_WIDTH, THEME_MEDIA_TYPE_MAX_WIDTH,
/** Minimum height constraint. */
THEME_MEDIA_TYPE_MIN_HEIGHT, THEME_MEDIA_TYPE_MIN_HEIGHT,
/** Maximum height constraint. */
THEME_MEDIA_TYPE_MAX_HEIGHT, THEME_MEDIA_TYPE_MAX_HEIGHT,
/** Monitor id constraint. */
THEME_MEDIA_TYPE_MON_ID, THEME_MEDIA_TYPE_MON_ID,
/** Minimum aspect ratio constraint. */
THEME_MEDIA_TYPE_MIN_ASPECT_RATIO, THEME_MEDIA_TYPE_MIN_ASPECT_RATIO,
/** Maximum aspect ratio constraint. */
THEME_MEDIA_TYPE_MAX_ASPECT_RATIO, THEME_MEDIA_TYPE_MAX_ASPECT_RATIO,
/** Invalid entry. */
THEME_MEDIA_TYPE_INVALID, THEME_MEDIA_TYPE_INVALID,
} ThemeMediaType; } ThemeMediaType;
/**
* Theme Media description.
*/
typedef struct ThemeMedia { typedef struct ThemeMedia {
ThemeMediaType type; ThemeMediaType type;
double value; double value;
@ -348,6 +360,18 @@ char * rofi_theme_parse_prepare_file ( const char *file, const char *parent_file
* Process conditionals. * Process conditionals.
*/ */
void rofi_theme_parse_process_conditionals ( void ); 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 ); 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 ); ThemeMediaType rofi_theme_parse_media_type ( const char *type );
#endif #endif

View file

@ -56,9 +56,13 @@
#include "history.h" #include "history.h"
#include "dialogs/ssh.h" #include "dialogs/ssh.h"
/**
* Holding an ssh entry.
*/
typedef struct _SshEntry { typedef struct _SshEntry {
/** SSH hostname */
char *hostname; char *hostname;
/** SSH port number */
int port; int port;
} SshEntry; } SshEntry;
/** /**

View file

@ -25,13 +25,20 @@
* *
*/ */
/** Log domain used by timings.*/
#define G_LOG_DOMAIN "Timings" #define G_LOG_DOMAIN "Timings"
#include "config.h" #include "config.h"
#include <stdio.h> #include <stdio.h>
#include "rofi.h" #include "rofi.h"
#include "timings.h" #include "timings.h"
/**
* Timer used to calculate time stamps.
*/
GTimer *global_timer = NULL; GTimer *global_timer = NULL;
/**
* Last timestamp made.
*/
double global_timer_last = 0.0; double global_timer_last = 0.0;
void rofi_timings_init ( void ) void rofi_timings_init ( void )

View file

@ -127,7 +127,11 @@ struct _listview
unsigned int cur_visible; unsigned int cur_visible;
} barview; } 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] = { const char *const listview_theme_prop_names[][3] = {
/** Normal row */ /** Normal row */
{ "normal.normal", "selected.normal", "alternate.normal" }, { "normal.normal", "selected.normal", "alternate.normal" },