From b59552003ed62c635fbcbf64d15662ecdc0c8c1a Mon Sep 17 00:00:00 2001 From: Dave Davenport Date: Thu, 7 Jan 2016 13:32:33 +0100 Subject: [PATCH] More doxygen sugar --- include/rofi.h | 2 +- include/textbox.h | 16 +++++----- include/xrmoptions.h | 76 +++++++++++++++++++++++++++++++++++++++++--- source/rofi.c | 6 ++-- source/xrmoptions.c | 4 +-- 5 files changed, 86 insertions(+), 18 deletions(-) diff --git a/include/rofi.h b/include/rofi.h index 62e0e8ab..b2c5eda1 100644 --- a/include/rofi.h +++ b/include/rofi.h @@ -4,7 +4,7 @@ #include #include #include -#include +#include "textbox.h" #include #include #include "timings.h" diff --git a/include/textbox.h b/include/textbox.h index daa57aff..cc8c6494 100644 --- a/include/textbox.h +++ b/include/textbox.h @@ -39,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 diff --git a/include/xrmoptions.h b/include/xrmoptions.h index 073369f5..88b57183 100644 --- a/include/xrmoptions.h +++ b/include/xrmoptions.h @@ -1,7 +1,28 @@ #ifndef ROFI_XRMOPTIONS_H #define ROFI_XRMOPTIONS_H +// Big thanks to Sean Pringle for this code. /** + * @defgroup CONFXResources XResources Configuration + * @ingroup CONFIGURATION + * + * Configuration described in Xresource format. This can be loaded from the X server or file. + * + * @defgroup CONFXServer XServer Configuration + * @ingroup CONFXResources + * + * Loads the configuration directly from the X server using the XResources system. + * + * @defgroup CONFCommandline Commandline Configuration + * @ingroup CONFIGURATION + * + * Modified the configuration based on commandline arguments + * + * @defgroup CONFFile File Configuration + * @ingroup CONFXResources + * + * Loads the configuration from a config file that uses the XResource file format. + * * @defgroup CONFIGURATION Configuration * * This provides rofi configuration system, supports: @@ -13,7 +34,6 @@ * @{ */ -// Big thanks to Sean Pringle for this code. // This maps xresource options to config structure. typedef enum { @@ -29,49 +49,97 @@ typedef enum * * Parse the rofi related X resource options of the * connected X server. + * + * @ingroup CONFXServer */ void config_parse_xresource_options ( Display *display ); + +/** + * @ingroup CONFFile + */ void config_parse_xresource_options_file ( const char *filename ); /** * Parse commandline options. + * @ingroup CONFCommandline */ void config_parse_cmd_options ( void ); + /** * Parse dynamic commandline options. + * @ingroup CONFCommandline */ void config_parse_cmd_options_dynamic ( void ); + /** * @param display Handler of the display to fetch the settings from. * * Parse the rofi related X resource options of the * connected X server. + * + * @ingroup CONFXServer */ void config_parse_xresource_options_dynamic ( Display *display ); + +/** + * @ingroup CONFFile + */ void config_parse_xresource_options_dynamic_file ( const char *filename ); /** * Initializes the Xresourced system. + * + * @ingroup CONFXResources */ void config_parse_xresource_init ( void ); /** * Free any allocated memory. + * + * @ingroup CONFXResources */ void config_xresource_free ( void ); /** * Dump the settings in a Xresources compatible way to * stdout. + * + * @ingroup CONFXResources */ -void xresource_dump ( void ); +void config_parse_xresource_dump ( void ); /** - * Add option to the dynamic option parser. + * Dump the theme related settings in Xresources compatible way to + * stdout. + * + * @ingroup CONFXResources + */ +void config_parse_xresources_theme_dump ( void ); + +/** + * @param type The type of the value + * @param key The key refering to this configuration option + * @param value The value to update based [out][in] + * @param command Description of this configuration option + * + * Add option (at runtime) to the dynamic option parser. */ void config_parser_add_option ( XrmOptionType type, const char *key, void **value, const char *comment ); + +/** + * Print the current configuration to stdout. Uses bold/italic when printing to terminal. + */ void print_options ( void ); + +/** + * @param option The name of the option + * @param type String describing the type + * @param text Description of the option + * @param def Current value of the option + * @param isatty If printed to a terminal + * + * Function that does the markup for printing an configuration option to stdout. + */ void print_help_msg ( const char *option, const char *type, const char*text, const char *def, int isatty ); -void print_xresources_theme ( void ); /* @}*/ #endif diff --git a/source/rofi.c b/source/rofi.c index cd843ea4..5ced847d 100644 --- a/source/rofi.c +++ b/source/rofi.c @@ -2315,7 +2315,7 @@ static int main_loop_signal_handler ( char command, int quiet ) } // Got message to print info else if ( command == 'i' ) { - xresource_dump (); + config_parse_xresource_dump (); } return FALSE; } @@ -2487,11 +2487,11 @@ int main ( int argc, char *argv[] ) exit ( EXIT_SUCCESS ); } if ( find_arg ( "-dump-xresources" ) >= 0 ) { - xresource_dump (); + config_parse_xresource_dump (); exit ( EXIT_SUCCESS ); } if ( find_arg ( "-dump-xresources-theme" ) >= 0 ) { - print_xresources_theme (); + config_parse_xresources_theme_dump (); exit ( EXIT_SUCCESS ); } // Parse the keybindings. diff --git a/source/xrmoptions.c b/source/xrmoptions.c index f09b61b9..c66be851 100644 --- a/source/xrmoptions.c +++ b/source/xrmoptions.c @@ -406,7 +406,7 @@ static void xresource_dump_entry ( const char *namePrefix, XrmOption *option ) printf ( "\n" ); } -void xresource_dump ( void ) +void config_parse_xresource_dump ( void ) { const char * namePrefix = "rofi"; unsigned int entries = sizeof ( xrmOptions ) / sizeof ( *xrmOptions ); @@ -543,7 +543,7 @@ void print_help_msg ( const char *option, const char *type, const char*text, con } } -void print_xresources_theme ( void ) +void config_parse_xresources_theme_dump ( void ) { if ( config.color_enabled != TRUE ) { printf ( "! Dumping theme only works for the extended color scheme.\n" );