1
0
mirror of https://github.com/weechat/weechat.git synced 2026-07-03 00:03:12 +02:00

core, plugins: fix typos in comments on functions, use imperative

This commit is contained in:
Sébastien Helleu
2026-03-23 20:45:36 +01:00
parent d34eb40187
commit f53e7fb9ef
342 changed files with 6669 additions and 6729 deletions
+5 -5
View File
@@ -37,7 +37,7 @@ struct t_gui_bar_item *fset_bar_item_fset = NULL;
/*
* Updates fset bar item if fset is enabled.
* Update fset bar item if fset is enabled.
*/
void
@@ -47,7 +47,7 @@ fset_bar_item_update (void)
}
/*
* Returns content of bar item "fset": help on currently selected option.
* Return content of bar item "fset": help on currently selected option.
*/
char *
@@ -225,9 +225,9 @@ fset_bar_item_fset_cb (const void *pointer, void *data,
}
/*
* Initializes fset bar items.
* Initialize fset bar items.
*
* Returns:
* Return:
* 1: OK
* 0: error
*/
@@ -243,7 +243,7 @@ fset_bar_item_init (void)
}
/*
* Ends fset bar items.
* End fset bar items.
*/
void
+23 -25
View File
@@ -40,7 +40,7 @@ struct t_hashtable *fset_buffer_hashtable_extra_vars = NULL;
/*
* Sets title of fset buffer.
* Set title of fset buffer.
*/
void
@@ -105,10 +105,10 @@ fset_buffer_set_title (void)
}
/*
* Fills a field with spaces (according to max length for this field).
* Fill a field with spaces (according to max length for this field).
*
* If fill_right == 1, fills with spaces on the right. Otherwise
* fills with spaces on the left before the value.
* If fill_right == 1, fill with spaces on the right. Otherwise
* fill with spaces on the left before the value.
*
* If skip_colors == 1, the field value may contain color codes, so
* weechat_strlen_screen() is used instead of weechat_utf8_strlen_screen()
@@ -158,9 +158,9 @@ fset_buffer_fills_field (char *field, char *field_spaces,
}
/*
* Displays a line with an fset option using an evaluated format.
* Display a line with an fset option using an evaluated format.
*
* Returns the index of last line displayed in buffer (this depends on the
* Return the index of last line displayed in buffer (this depends on the
* format number used), -1 if no option was displayed.
*/
@@ -887,10 +887,10 @@ fset_buffer_display_option_eval (struct t_fset_option *fset_option)
}
/*
* Displays a line with an fset option using a predefined format
* Display a line with an fset option using a predefined format
* (much faster because there is no eval).
*
* Returns the index of last line displayed in buffer (this depends on the
* Return the index of last line displayed in buffer (this depends on the
* format number used), -1 if no option was displayed.
*/
@@ -1075,9 +1075,9 @@ fset_buffer_display_option_predefined_format (struct t_fset_option *fset_option)
}
/*
* Displays a line with an fset option.
* Display a line with an fset option.
*
* Returns the index of last line displayed in buffer (this depends on the
* Return the index of last line displayed in buffer (this depends on the
* format number used), -1 if no option was displayed.
*/
@@ -1097,7 +1097,7 @@ fset_buffer_display_option (struct t_fset_option *fset_option)
}
/*
* Returns the last line index (y) for a buffer with free content,
* Return the last line index (y) for a buffer with free content,
* -1 if buffer is empty.
*/
@@ -1127,7 +1127,7 @@ fset_buffer_get_last_y (struct t_gui_buffer *buffer)
}
/*
* Updates list of options in fset buffer.
* Update list of options in fset buffer.
*/
void
@@ -1172,7 +1172,7 @@ fset_buffer_refresh (int clear)
}
/*
* Sets current selected line.
* Set current selected line.
*/
void
@@ -1199,7 +1199,7 @@ fset_buffer_set_current_line (int line)
}
/*
* Gets info about a window.
* Get info about a window.
*/
void
@@ -1235,7 +1235,7 @@ fset_buffer_get_window_info (struct t_gui_window *window,
}
/*
* Checks if current line is outside window and adjusts scroll if needed.
* Check if current line is outside window and adjusts scroll if needed.
*/
void
@@ -1474,8 +1474,7 @@ fset_buffer_close_cb (const void *pointer, void *data,
}
/*
* Restore buffer callbacks (input and close) for buffer created by fset
* plugin.
* Restore buffer callbacks (input and close) for buffer created by fset plugin.
*/
void
@@ -1493,10 +1492,9 @@ fset_buffer_set_callbacks (void)
}
/*
* Sets keys on fset buffer.
* Set keys on fset buffer.
*
* If hashtable is not NULL, it is used to set keys, otherwise keys are directly
* set in the fset buffer.
* If hashtable is not NULL, set keys inside instead of the fset buffer.
*/
void
@@ -1551,7 +1549,7 @@ fset_buffer_set_keys (struct t_hashtable *hashtable)
}
/*
* Sets the local variable "filter" in the fset buffer.
* Set the local variable "filter" in the fset buffer.
*/
void
@@ -1565,7 +1563,7 @@ fset_buffer_set_localvar_filter (void)
}
/*
* Opens fset buffer.
* Open fset buffer.
*/
void
@@ -1606,9 +1604,9 @@ fset_buffer_open (void)
}
/*
* Initializes fset buffer.
* Initialize fset buffer.
*
* Returns:
* Return:
* 1: OK
* 0: error
*/
@@ -1644,7 +1642,7 @@ fset_buffer_init (void)
}
/*
* Ends fset buffer.
* End fset buffer.
*/
void
+5 -5
View File
@@ -35,7 +35,7 @@
/*
* Gets the currently selected fset_option pointer and the associated
* Get the currently selected fset_option pointer and the associated
* config_option pointer.
*/
@@ -53,7 +53,7 @@ fset_command_get_option (struct t_fset_option **fset_option,
}
/*
* Gets an integer argument given to the /fset command.
* Get an integer argument given to the /fset command.
*/
int
@@ -469,7 +469,7 @@ fset_command_fset (const void *pointer, void *data,
}
/*
* Hooks execution of command "/set".
* Hook execution of command "/set".
*/
int
@@ -598,7 +598,7 @@ end:
}
/*
* Hooks execution of command "/key".
* Hook execution of command "/key".
*/
int
@@ -636,7 +636,7 @@ fset_command_run_key_cb (const void *pointer, void *data,
}
/*
* Hooks fset commands.
* Hook fset commands.
*/
void
+2 -2
View File
@@ -28,7 +28,7 @@
/*
* Adds current server to completion list.
* Add current server to completion list.
*/
int
@@ -113,7 +113,7 @@ fset_completion_option_cb (const void *pointer, void *data,
}
/*
* Hooks completions.
* Hook completions.
*/
void
+8 -8
View File
@@ -111,7 +111,7 @@ int fset_config_format_option_num_lines[2] = { 1, 1 };
/*
* Reloads fset configuration file.
* Reload fset configuration file.
*/
int
@@ -258,9 +258,9 @@ fset_config_change_use_keys_cb (const void *pointer, void *data,
}
/*
* Counts the number of "substring" in "string".
* Count the number of "substring" in "string".
*
* Returns the number of times substring is in string.
* Return the number of times substring is in string.
*/
int
@@ -359,9 +359,9 @@ fset_config_change_title_color_cb (const void *pointer, void *data,
}
/*
* Initializes fset configuration file.
* Initialize fset configuration file.
*
* Returns:
* Return:
* 1: OK
* 0: error
*/
@@ -1146,7 +1146,7 @@ fset_config_init (void)
}
/*
* Reads fset configuration file.
* Read fset configuration file.
*/
int
@@ -1167,7 +1167,7 @@ fset_config_read (void)
}
/*
* Writes fset configuration file.
* Write fset configuration file.
*/
int
@@ -1177,7 +1177,7 @@ fset_config_write (void)
}
/*
* Frees fset configuration.
* Free fset configuration.
*/
void
+2 -2
View File
@@ -31,7 +31,7 @@
/*
* Returns fset infolist "fset_option".
* Return fset infolist "fset_option".
*/
struct t_infolist *
@@ -92,7 +92,7 @@ fset_info_infolist_fset_option_cb (const void *pointer, void *data,
}
/*
* Hooks infolist and hdata.
* Hook infolist and hdata.
*/
void
+5 -5
View File
@@ -127,7 +127,7 @@ fset_mouse_get_distance_x (int x, int x2)
}
/*
* Returns an integer value from the hashtable (where value is a string).
* Return an integer value from the hashtable (where value is a string).
* If value is invalid, "default_value" is returned.
*/
@@ -152,7 +152,7 @@ fset_mouse_get_hashtable_int (struct t_hashtable *hashtable,
}
/*
* Gets coordinates from hashtable.
* Get coordinates from hashtable.
*/
void
@@ -310,9 +310,9 @@ fset_mouse_hsignal_cb (const void *pointer, void *data, const char *signal,
}
/*
* Initializes mouse.
* Initialize mouse.
*
* Returns:
* Return:
* 1: OK
* 0: error
*/
@@ -359,7 +359,7 @@ fset_mouse_init (void)
}
/*
* Ends mouse.
* End mouse.
*/
void
+49 -52
View File
@@ -58,9 +58,9 @@ char *fset_option_type_string_tiny[FSET_OPTION_NUM_TYPES] =
/*
* Checks if a fset option pointer is valid.
* Check if a fset option pointer is valid.
*
* Returns:
* Return:
* 1: option exists
* 0: option does not exist
*/
@@ -87,12 +87,12 @@ fset_option_valid (struct t_fset_option *fset_option)
}
/*
* Searches for an option by name.
* Search for an option by name.
*
* If line is not NULL, *line is set with the line number of option found
* (-1 if line is not found).
*
* Returns pointer to option found, NULL if not found.
* Return pointer to option found, NULL if not found.
*/
struct t_fset_option *
@@ -124,9 +124,9 @@ fset_option_search_by_name (const char *name, int *line)
}
/*
* Checks if the option value is changed (different from the default value).
* Check if the option value is changed (different from the default value).
*
* Returns:
* Return:
* 1: value has been changed
* 0: value is the same as default value
*/
@@ -148,7 +148,7 @@ fset_option_value_is_changed (struct t_fset_option *fset_option)
}
/*
* Sets the value in option, according to its type.
* Set the value in option, according to its type.
*/
void
@@ -203,13 +203,12 @@ fset_option_set_value_string (struct t_config_option *option,
}
/*
* Checks if a string matches a mask.
* Check if a string matches a mask.
*
* If mask has no "*" inside, it just checks if "mask" is inside the "string".
* If mask has at least one "*" inside, the function weechat_string_match is
* used.
* If mask has no "*" inside, just check if "mask" is inside the "string".
* If mask has at least one "*" inside, use the function weechat_string_match.
*
* Returns:
* Return:
* 1: string matches mask
* 0: string does not match mask
*/
@@ -224,7 +223,7 @@ fset_option_string_match (const char *string, const char *mask)
}
/*
* Adds the properties of an fset option in a hashtable
* Add the properties of an fset option in a hashtable
* (keys and values must be strings).
*/
@@ -295,9 +294,9 @@ fset_option_add_option_in_hashtable (struct t_hashtable *hashtable,
}
/*
* Checks if an option is matching current filter(s).
* Check if an option is matching current filter(s).
*
* Returns:
* Return:
* 1: option is matching filter(s)
* 0: option does not match filter(s)
*/
@@ -415,7 +414,7 @@ fset_option_match_filter (struct t_fset_option *fset_option, const char *filter)
}
/*
* Sets (or sets again) values (except name) in an fset option.
* Set (or sets again) values (except name) in an fset option.
*/
void
@@ -573,7 +572,7 @@ fset_option_set_values (struct t_fset_option *fset_option,
}
/*
* Sets max length for fields, for one option.
* Set max length for fields, for one option.
*/
void
@@ -731,7 +730,7 @@ fset_option_set_max_length_fields_option (struct t_fset_option *fset_option)
}
/*
* Initializes max length for fields.
* Initialize max length for fields.
*/
void
@@ -741,7 +740,7 @@ fset_option_init_max_length (struct t_fset_option_max_length *max_length)
}
/*
* Sets max length for fields, for all options.
* Set max length for fields, for all options.
*/
void
@@ -764,10 +763,9 @@ fset_option_set_max_length_fields_all (void)
}
/*
* Allocates an fset option structure using a pointer to a
* WeeChat/plugin option.
* Allocate an fset option structure using a pointer to a WeeChat/plugin option.
*
* Returns pointer to new fset option, NULL if error.
* Return pointer to new fset option, NULL if error.
*/
struct t_fset_option *
@@ -802,10 +800,9 @@ fset_option_alloc (struct t_config_option *option)
}
/*
* Allocates an fset option structure using a pointer to a
* WeeChat/plugin option.
* Allocate an fset option structure using a pointer to a WeeChat/plugin option.
*
* Returns pointer to new fset option, NULL if the option does not match
* Return pointer to new fset option, NULL if the option does not match
* filters or if error.
*/
@@ -839,7 +836,7 @@ fset_option_add (struct t_config_option *option)
}
/*
* Compares two options to sort them by name.
* Compare two options to sort them by name.
*/
int
@@ -882,7 +879,7 @@ fset_option_compare_options_cb (void *data, struct t_arraylist *arraylist,
}
/*
* Frees an fset option.
* Free an fset option.
*/
void
@@ -909,7 +906,7 @@ fset_option_free (struct t_fset_option *fset_option)
}
/*
* Frees an fset option (arraylist callback).
* Free an fset option (arraylist callback).
*/
void
@@ -927,7 +924,7 @@ fset_option_free_cb (void *data, struct t_arraylist *arraylist, void *pointer)
}
/*
* Allocates and returns the arraylist to store options.
* Allocate and return the arraylist to store options.
*/
struct t_arraylist *
@@ -939,7 +936,7 @@ fset_option_get_arraylist_options (void)
}
/*
* Allocates and returns the structure to store max length of fields.
* Allocate and return the structure to store max length of fields.
*/
struct t_fset_option_max_length *
@@ -955,7 +952,7 @@ fset_option_get_max_length (void)
}
/*
* Gets all options to display in fset buffer.
* Get all options to display in fset buffer.
*/
void
@@ -1053,7 +1050,7 @@ fset_option_get_options (void)
}
/*
* Sets the filter.
* Set the filter.
*/
void
@@ -1065,7 +1062,7 @@ fset_option_set_filter (const char *filter)
}
/*
* Filters options.
* Filter options.
*/
void
@@ -1083,7 +1080,7 @@ fset_option_filter_options (const char *filter)
}
/*
* Toggles a boolean option.
* Toggle a boolean option.
*/
void
@@ -1098,7 +1095,7 @@ fset_option_toggle_value (struct t_fset_option *fset_option,
}
/*
* Adds a value to an integer/enum/color option.
* Add a value to an integer/enum/color option.
*/
void
@@ -1122,7 +1119,7 @@ fset_option_add_value (struct t_fset_option *fset_option,
}
/*
* Resets the value of an option.
* Reset the value of an option.
*/
void
@@ -1139,7 +1136,7 @@ fset_option_reset_value (struct t_fset_option *fset_option,
}
/*
* Unsets the value of an option.
* Unset the value of an option.
*/
void
@@ -1156,7 +1153,7 @@ fset_option_unset_value (struct t_fset_option *fset_option,
}
/*
* Sets the value of an option.
* Set the value of an option.
*
* If set_mode == -1, edit an empty value.
* If set_mode == 0, edit the current value.
@@ -1212,7 +1209,7 @@ fset_option_set (struct t_fset_option *fset_option,
}
/*
* Marks/unmarks an option.
* Mark/unmark an option.
*/
void
@@ -1276,7 +1273,7 @@ fset_option_mark_options_matching_filter (const char *filter, int mark)
}
/*
* Unmarks all options.
* Unmark all options.
*/
void
@@ -1309,12 +1306,12 @@ fset_option_unmark_all (void)
}
/*
* Exports options currently displayed in fset buffer.
* Export options currently displayed in fset buffer.
*
* If with_help == 1, the help is displayed above each option
* and options are separated by an empty line.
*
* Returns:
* Return:
* 1: export OK
* 0: error
*/
@@ -1398,9 +1395,9 @@ fset_option_export (const char *filename, int with_help)
}
/*
* Imports options from a file: all lines starting with "/" are executed.
* Import options from a file: all lines starting with "/" are executed.
*
* Returns:
* Return:
* -2: not enough memory
* -1: file not found
* >= 0: number of commands executed in file
@@ -1462,7 +1459,7 @@ fset_option_import (const char *filename)
}
/*
* Refreshes the fset buffer after the change of an option.
* Refresh the fset buffer after the change of an option.
*/
void
@@ -1671,7 +1668,7 @@ fset_option_config_cb (const void *pointer,
}
/*
* Returns hdata for option.
* Return hdata for option.
*/
struct t_hdata *
@@ -1707,9 +1704,9 @@ fset_option_hdata_option_cb (const void *pointer, void *data,
}
/*
* Adds a fset option in an infolist.
* Add a fset option in an infolist.
*
* Returns:
* Return:
* 1: OK
* 0: error
*/
@@ -1770,7 +1767,7 @@ fset_option_add_to_infolist (struct t_infolist *infolist,
}
/*
* Prints fset options in WeeChat log file (usually for crash dump).
* Print fset options in WeeChat log file (usually for crash dump).
*/
void
@@ -1809,9 +1806,9 @@ fset_option_print_log (void)
}
/*
* Initializes fset list of options.
* Initialize fset list of options.
*
* Returns:
* Return:
* 1: OK
* 0: error
*/
@@ -1889,7 +1886,7 @@ fset_option_init (void)
}
/*
* Ends fset list of options.
* End fset list of options.
*/
void
+3 -3
View File
@@ -84,7 +84,7 @@ fset_debug_dump_cb (const void *pointer, void *data,
}
/*
* Adds the fset bar.
* Add the fset bar.
*/
void
@@ -99,7 +99,7 @@ fset_add_bar (void)
}
/*
* Initializes fset plugin.
* Initialize fset plugin.
*/
int
@@ -160,7 +160,7 @@ weechat_plugin_init (struct t_weechat_plugin *plugin, int argc, char *argv[])
}
/*
* Ends fset plugin.
* End fset plugin.
*/
int