mirror of
https://github.com/davatorium/rofi.git
synced 2024-11-18 13:54:36 -05:00
Add some doxygen sugar.
This commit is contained in:
parent
7f621a4a91
commit
504e27f701
18 changed files with 143 additions and 23 deletions
|
@ -1,5 +1,14 @@
|
|||
#ifndef __COMBI_DIALOG_H__
|
||||
#define __COMBI_DIALOG_H__
|
||||
#ifndef ROFI_DIALOG_COMBI_H
|
||||
#define ROFI_DIALOG_COMBI_H
|
||||
|
||||
/**
|
||||
* @defgroup COBIMode Combi
|
||||
* @ingroup MODES
|
||||
*
|
||||
* @{
|
||||
*/
|
||||
|
||||
extern Mode combi_mode;
|
||||
#endif
|
||||
|
||||
/*@}*/
|
||||
#endif // ROFI_DIALOG_COMBI_H
|
||||
|
|
|
@ -1,6 +1,9 @@
|
|||
#ifndef ROFI_DIALOGS_DIALOGS_H
|
||||
#define ROFI_DIALOGS_DIALOGS_H
|
||||
|
||||
/**
|
||||
* @defgroup MODES Modes
|
||||
*/
|
||||
/**
|
||||
* List of available dialogs.
|
||||
*/
|
||||
|
|
|
@ -1,6 +1,13 @@
|
|||
#ifndef __DMENU_DIALOG_H__
|
||||
#define __DMENU_DIALOG_H__
|
||||
#ifndef ROFI_DIALOG_DMENU_H
|
||||
#define ROFI_DIALOG_DMENU_H
|
||||
|
||||
/**
|
||||
* @defgroup DMENU DMenu
|
||||
* @ingroup MODES
|
||||
*
|
||||
*
|
||||
* @{
|
||||
*/
|
||||
/**
|
||||
* dmenu dialog.
|
||||
*
|
||||
|
@ -9,4 +16,6 @@
|
|||
int dmenu_switcher_dialog ( void );
|
||||
|
||||
void print_dmenu_options ( void );
|
||||
#endif
|
||||
|
||||
/*@}*/
|
||||
#endif // ROFI_DIALOG_DMENU_H
|
||||
|
|
|
@ -1,5 +1,11 @@
|
|||
#ifndef __DRUN_DIALOG_H__
|
||||
#define __DRUN_DIALOG_H__
|
||||
#ifndef ROFI_DIALOG_DRUN_H
|
||||
#define ROFI_DIALOG_DRUN_H
|
||||
|
||||
/**
|
||||
* @defgroup DRUNMode DRun
|
||||
* @ingroup MODES
|
||||
* @{
|
||||
*/
|
||||
extern Mode drun_mode;
|
||||
#endif
|
||||
/*@}*/
|
||||
#endif // ROFI_DIALOG_DRUN_H
|
||||
|
|
|
@ -3,6 +3,7 @@
|
|||
|
||||
/**
|
||||
* @defgroup RUNMode Run
|
||||
* @ingroup MODES
|
||||
*
|
||||
* This mode uses the following options from the #config object:
|
||||
* * #_Settings::run_command
|
||||
|
|
|
@ -1,6 +1,12 @@
|
|||
#ifndef __SCRIPT_DIALOG_H__
|
||||
#define __SCRIPT_DIALOG_H__
|
||||
#ifndef ROFI_DIALOG_SCRIPT_H
|
||||
#define ROFI_DIALOG_SCRIPT_H
|
||||
|
||||
/**
|
||||
* @defgroup SCRIPTMode Script
|
||||
* @ingroup MODES
|
||||
*
|
||||
* @{
|
||||
*/
|
||||
/**
|
||||
* @param str The input string to parse
|
||||
*
|
||||
|
@ -10,4 +16,5 @@
|
|||
* @returns NULL when it fails, a newly allocated ScriptOptions when successful.
|
||||
*/
|
||||
Mode *script_switcher_parse_setup ( const char *str );
|
||||
#endif
|
||||
/*@}*/
|
||||
#endif // ROFI_DIALOG_SCRIPT_H
|
||||
|
|
|
@ -3,6 +3,7 @@
|
|||
|
||||
/**
|
||||
* @defgroup SSHMode SSH
|
||||
* @ingroup MODES
|
||||
*
|
||||
* SSH Mode, returns a list of known SSH hosts the user can log into.
|
||||
* It does this by parsing the SSH config file and optional the known host and host list
|
||||
|
|
|
@ -1,10 +1,17 @@
|
|||
#ifndef __WINDOW_DIALOG_H__
|
||||
#define __WINDOW_DIALOG_H__
|
||||
#ifndef ROFI_DIALOG_WINDOW_H
|
||||
#define ROFI_DIALOG_WINDOW_H
|
||||
|
||||
/**
|
||||
* @defgroup WINDOWMode Window
|
||||
* @ingroup MODES
|
||||
*
|
||||
* @{
|
||||
*/
|
||||
#include <config.h>
|
||||
#ifdef WINDOW_MODE
|
||||
|
||||
extern Mode window_mode;
|
||||
extern Mode window_mode_cd;
|
||||
#endif // WINDOW_MODE
|
||||
#endif // __WINDOW_DIALOG_H__
|
||||
/* @}*/
|
||||
#endif // ROFI_DIALOG_WINDOW_H
|
||||
|
|
|
@ -1,6 +1,16 @@
|
|||
#ifndef ROFI_HELPER_H
|
||||
#define ROFI_HELPER_H
|
||||
#include "rofi.h"
|
||||
|
||||
/**
|
||||
* @defgroup HELPERS Helpers
|
||||
*/
|
||||
/**
|
||||
* @defgroup HELPER Helper
|
||||
* @ingroup HELPERS
|
||||
*
|
||||
* @{
|
||||
*/
|
||||
/**
|
||||
* @param string The input string.
|
||||
* @param output Pointer to 2 dimensional array with parsed string.
|
||||
|
@ -155,4 +165,6 @@ void cmd_set_arguments ( int argc, char **argv );
|
|||
*/
|
||||
char *rofi_expand_path ( const char *input );
|
||||
unsigned int levenshtein ( const char *needle, const char *haystack );
|
||||
|
||||
/*@}*/
|
||||
#endif // ROFI_HELPER_H
|
||||
|
|
|
@ -3,6 +3,7 @@
|
|||
|
||||
/**
|
||||
* @defgroup HISTORY History
|
||||
* @ingroup HELPERS
|
||||
*
|
||||
* Implements a very simple history module that can be used by a #Mode.
|
||||
*
|
||||
|
|
|
@ -2,7 +2,12 @@
|
|||
#define ROFI_I3_H
|
||||
|
||||
/**
|
||||
* @defgroup I3Support I3Support
|
||||
* @ingroup HELPERS
|
||||
*
|
||||
* These functions are dummies when i3 support is not compiled in.
|
||||
*
|
||||
* @{
|
||||
*/
|
||||
|
||||
/**
|
||||
|
@ -29,4 +34,5 @@ int i3_support_initialize ( Display *display );
|
|||
* Cleanup.
|
||||
*/
|
||||
void i3_support_free_internals ( void );
|
||||
/*@}*/
|
||||
#endif // ROFI_I3_H
|
||||
|
|
|
@ -1,6 +1,12 @@
|
|||
#ifndef ROFI_KEYB_H
|
||||
#define ROFI_KEYB_H
|
||||
|
||||
/**
|
||||
* @defgroup KEYB KeyboardBindings
|
||||
*
|
||||
* @{
|
||||
*/
|
||||
|
||||
typedef enum _KeyBindingAction
|
||||
{
|
||||
PASTE_PRIMARY = 0,
|
||||
|
@ -80,4 +86,6 @@ void cleanup_abe ( void );
|
|||
* @returns TRUE if key combo matches, FALSE otherwise.
|
||||
*/
|
||||
int abe_test_action ( KeyBindingAction action, unsigned int mask, KeySym key );
|
||||
|
||||
/*@}*/
|
||||
#endif // ROFI_KEYB_H
|
||||
|
|
|
@ -10,6 +10,10 @@
|
|||
#include "timings.h"
|
||||
#include "keyb.h"
|
||||
|
||||
/**
|
||||
* @defgroup Widgets Widgets
|
||||
*/
|
||||
|
||||
/**
|
||||
* Pointer to xdg cache directory.
|
||||
*/
|
||||
|
|
|
@ -1,6 +1,13 @@
|
|||
#ifndef ROFI_SCROLLBAR_H
|
||||
#define ROFI_SCROLLBAR_H
|
||||
#include <cairo.h>
|
||||
|
||||
/**
|
||||
* @defgroup Scrollbar Scrollbar
|
||||
* @ingroup Widgets
|
||||
*
|
||||
* @{
|
||||
*/
|
||||
/**
|
||||
* Internal structure for the scrollbar.
|
||||
*/
|
||||
|
@ -90,4 +97,6 @@ void scrollbar_resize ( scrollbar *sb, int w, int h );
|
|||
* Move the scrollbar.
|
||||
*/
|
||||
void scrollbar_move ( scrollbar *sb, int x, int y );
|
||||
|
||||
/*@}*/
|
||||
#endif // ROFI_SCROLLBAR_H
|
||||
|
|
|
@ -7,6 +7,13 @@
|
|||
#include <pango/pangocairo.h>
|
||||
#include <cairo.h>
|
||||
|
||||
/**
|
||||
* @defgroup Textbox Textbox
|
||||
* @ingroup Widgets
|
||||
*
|
||||
* @{
|
||||
*/
|
||||
|
||||
typedef struct
|
||||
{
|
||||
double red, green, blue, alpha;
|
||||
|
@ -32,14 +39,14 @@ typedef struct
|
|||
|
||||
typedef enum
|
||||
{
|
||||
TB_AUTOHEIGHT = 1 << 0,
|
||||
TB_AUTOWIDTH = 1 << 1,
|
||||
TB_LEFT = 1 << 16,
|
||||
TB_RIGHT = 1 << 17,
|
||||
TB_CENTER = 1 << 18,
|
||||
TB_EDITABLE = 1 << 19,
|
||||
TB_MARKUP = 1 << 20,
|
||||
TB_WRAP = 1 << 21,
|
||||
TB_AUTOHEIGHT = 1 << 0,
|
||||
TB_AUTOWIDTH = 1 << 1,
|
||||
TB_LEFT = 1 << 16,
|
||||
TB_RIGHT = 1 << 17,
|
||||
TB_CENTER = 1 << 18,
|
||||
TB_EDITABLE = 1 << 19,
|
||||
TB_MARKUP = 1 << 20,
|
||||
TB_WRAP = 1 << 21,
|
||||
} TextboxFlags;
|
||||
|
||||
typedef enum
|
||||
|
@ -233,4 +240,6 @@ void textbox_delete ( textbox *tb, int pos, int dlen );
|
|||
void textbox_moveresize ( textbox *tb, int x, int y, int w, int h );
|
||||
int textbox_get_estimated_char_height ( void );
|
||||
void textbox_set_pango_context ( PangoContext *p );
|
||||
|
||||
/*@}*/
|
||||
#endif //ROFI_TEXTBOX_H
|
||||
|
|
|
@ -1,6 +1,12 @@
|
|||
#ifndef ROFI_TIMINGS_H
|
||||
#define ROFI_TIMINGS_H
|
||||
#include <config.h>
|
||||
|
||||
/**
|
||||
* @defgroup TIMINGS Timings
|
||||
* @ingroup HELPERS
|
||||
* @{
|
||||
*/
|
||||
#if TIMINGS
|
||||
|
||||
void rofi_timings_init ( void );
|
||||
|
@ -20,4 +26,5 @@ void rofi_timings_quit ( void );
|
|||
#define TICK_N( a )
|
||||
|
||||
#endif // TIMINGS
|
||||
/*@}*/
|
||||
#endif // ROFI_TIMINGS_H
|
||||
|
|
|
@ -1,6 +1,12 @@
|
|||
#ifndef X11_ROFI_HELPER_H
|
||||
#define X11_ROFI_HELPER_H
|
||||
|
||||
/**
|
||||
* @defgroup X11Helper X11Helper
|
||||
* @ingroup HELPERS
|
||||
* @{
|
||||
*/
|
||||
|
||||
int window_get_prop ( Display *display, Window w, Atom prop,
|
||||
Atom *type, int *items,
|
||||
void *buffer, unsigned int bytes ) __attribute__ ( ( nonnull ( 4, 5 ) ) );
|
||||
|
@ -159,4 +165,5 @@ void color_cache_reset ( void );
|
|||
cairo_format_t get_format ( void );
|
||||
|
||||
void x11_helper_set_cairo_rgba ( cairo_t *d, unsigned int pixel );
|
||||
/*@}*/
|
||||
#endif
|
||||
|
|
|
@ -1,6 +1,18 @@
|
|||
#ifndef ROFI_XRMOPTIONS_H
|
||||
#define ROFI_XRMOPTIONS_H
|
||||
|
||||
/**
|
||||
* @defgroup CONFIGURATION Configuration
|
||||
*
|
||||
* This provides rofi configuration system, supports:
|
||||
* * Compiled defaults.
|
||||
* * XResource parsing
|
||||
* * Config file parsing
|
||||
* * Commandline options.
|
||||
*
|
||||
* @{
|
||||
*/
|
||||
|
||||
// Big thanks to Sean Pringle for this code.
|
||||
// This maps xresource options to config structure.
|
||||
typedef enum
|
||||
|
@ -60,4 +72,6 @@ void config_parser_add_option ( XrmOptionType type, const char *key, void **valu
|
|||
void print_options ( void );
|
||||
void print_help_msg ( const char *option, const char *type, const char*text, const char *def, int isatty );
|
||||
void print_xresources_theme ( void );
|
||||
|
||||
/* @}*/
|
||||
#endif
|
||||
|
|
Loading…
Reference in a new issue