pegasus/weechat
1
0
Fork 0
mirror of https://github.com/weechat/weechat.git synced 2026-07-09 19:23:13 +02:00
Code Activity

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

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files
src/core/hook/hook-command-run.c
+9 -9
View File
@@ -39,7 +39,7 @@
/*
* Returns description of hook.
* Return description of hook.
*
* Note: result must be freed after use.
*/
@@ -51,9 +51,9 @@ hook_command_run_get_description (struct t_hook *hook)
}
/*
* Hooks a command when it's run by WeeChat.
* Hook a command when it's run by WeeChat.
*
* Returns pointer to new hook, NULL if error.
* Return pointer to new hook, NULL if error.
*/
struct t_hook *
@@ -98,7 +98,7 @@ hook_command_run (struct t_weechat_plugin *plugin,
}
/*
* Executes a command_run hook.
* Execute a command_run hook.
*/
int
@@ -185,7 +185,7 @@ hook_command_run_exec (struct t_gui_buffer *buffer, const char *command)
}
/*
* Frees data in a command_run hook.
* Free data in a command_run hook.
*/
void
@@ -205,7 +205,7 @@ hook_command_run_free_data (struct t_hook *hook)
}
/*
* Returns hdata for command_run hook.
* Return hdata for command_run hook.
*/
struct t_hdata *
@@ -229,9 +229,9 @@ hook_command_run_hdata_hook_command_run_cb (const void *pointer, void *data,
}
/*
* Adds command_run hook data in the infolist item.
* Add command_run hook data in the infolist item.
*
* Returns:
* Return:
* 1: OK
* 0: error
*/
@@ -254,7 +254,7 @@ hook_command_run_add_to_infolist (struct t_infolist_item *item,
}
/*
* Prints command_run hook data in WeeChat log file (usually for crash dump).
* Print command_run hook data in WeeChat log file (usually for crash dump).
*/
void
src/core/hook/hook-command.c
+22 -22
View File
@@ -44,7 +44,7 @@
/*
* Returns description of hook.
* Return description of hook.
*
* Note: result must be freed after use.
*/
@@ -56,9 +56,9 @@ hook_command_get_description (struct t_hook *hook)
}
/*
* Searches for a command hook in list.
* Search for a command hook in list.
*
* Returns pointer to hook found, NULL if not found.
* Return pointer to hook found, NULL if not found.
*/
struct t_hook *
@@ -83,7 +83,7 @@ hook_command_search (struct t_weechat_plugin *plugin, const char *command)
}
/*
* Builds variables/arrays that will be used for completion of commands
* Build variables/arrays that will be used for completion of commands
* arguments.
*/
@@ -273,7 +273,7 @@ hook_command_build_completion (struct t_hook_command *hook_command)
}
/*
* Removes all raw markers from a string: converts "raw[xxx]" to "xxx".
* Remove all raw markers from a string: converts "raw[xxx]" to "xxx".
*
* Note: result must be freed after use.
*/
@@ -318,7 +318,7 @@ hook_command_remove_raw_markers (const char *string)
}
/*
* Frees an argument description.
* Free an argument description.
*/
void
@@ -333,7 +333,7 @@ hook_command_arraylist_arg_desc_free (void *data, struct t_arraylist *arraylist,
}
/*
* Formats and translates arguments description of a command.
* Format and translates arguments description of a command.
*
* Note: result must be freed after use.
*/
@@ -500,9 +500,9 @@ error:
}
/*
* Hooks a command.
* Hook a command.
*
* Returns pointer to new hook, NULL if error.
* Return pointer to new hook, NULL if error.
*/
struct t_hook *
@@ -576,9 +576,9 @@ hook_command (struct t_weechat_plugin *plugin, const char *command,
}
/*
* Executes a command hook.
* Execute a command hook.
*
* Returns:
* Return:
* HOOK_COMMAND_EXEC_OK: command executed successfully
* HOOK_COMMAND_EXEC_ERROR: command executed and failed
* HOOK_COMMAND_EXEC_NOT_FOUND: command not found
@@ -768,12 +768,12 @@ end:
}
/*
* Gets relevance for cmd2 (existing command) compared to cmd1 (non-existing
* Get relevance for cmd2 (existing command) compared to cmd1 (non-existing
* command).
*
* Both commands are in lower case.
*
* Returns a number based on the Levenshtein distance between two commands,
* Return a number based on the Levenshtein distance between two commands,
* lower is better.
*/
@@ -812,7 +812,7 @@ hook_command_similar_get_relevance (const char *cmd1, int length_cmd1,
}
/*
* Compares similar commands to sort them by relevance (lower number first:
* Compare similar commands to sort them by relevance (lower number first:
* best relevance).
*/
@@ -839,7 +839,7 @@ hook_command_similar_cmp_cb (void *data, struct t_arraylist *arraylist,
}
/*
* Frees a similar command.
* Free a similar command.
*/
void
@@ -854,7 +854,7 @@ hook_command_similar_free_cb (void *data, struct t_arraylist *arraylist,
}
/*
* Builds an arraylist with similar commands.
* Build an arraylist with similar commands.
*
* Note: result must be freed after use.
*/
@@ -906,7 +906,7 @@ hook_command_build_list_similar_commands (const char *command)
}
/*
* Displays an error on unknown command, with a list of existing similar
* Display an error on unknown command, with a list of existing similar
* command names.
*/
@@ -971,7 +971,7 @@ hook_command_display_error_unknown (const char *command)
}
/*
* Frees data in a command hook.
* Free data in a command hook.
*/
void
@@ -1049,7 +1049,7 @@ hook_command_free_data (struct t_hook *hook)
}
/*
* Returns hdata for command hook.
* Return hdata for command hook.
*/
struct t_hdata *
@@ -1084,9 +1084,9 @@ hook_command_hdata_hook_command_cb (const void *pointer, void *data,
}
/*
* Adds command hook data in the infolist item.
* Add command hook data in the infolist item.
*
* Returns:
* Return:
* 1: OK
* 0: error
*/
@@ -1141,7 +1141,7 @@ hook_command_add_to_infolist (struct t_infolist_item *item,
}
/*
* Prints command hook data in WeeChat log file (usually for crash dump).
* Print command hook data in WeeChat log file (usually for crash dump).
*/
void
src/core/hook/hook-completion.c
+9 -9
View File
@@ -39,7 +39,7 @@
/*
* Returns description of hook.
* Return description of hook.
*
* Note: result must be freed after use.
*/
@@ -51,9 +51,9 @@ hook_completion_get_description (struct t_hook *hook)
}
/*
* Hooks a completion.
* Hook a completion.
*
* Returns pointer to new hook, NULL if error.
* Return pointer to new hook, NULL if error.
*/
struct t_hook *
@@ -101,7 +101,7 @@ hook_completion (struct t_weechat_plugin *plugin, const char *completion_item,
}
/*
* Executes a completion hook.
* Execute a completion hook.
*/
void
@@ -158,7 +158,7 @@ hook_completion_exec (struct t_weechat_plugin *plugin,
}
/*
* Frees data in a completion hook.
* Free data in a completion hook.
*/
void
@@ -183,7 +183,7 @@ hook_completion_free_data (struct t_hook *hook)
}
/*
* Returns hdata for completion hook.
* Return hdata for completion hook.
*/
struct t_hdata *
@@ -207,9 +207,9 @@ hook_completion_hdata_hook_completion_cb (const void *pointer, void *data,
}
/*
* Adds completion hook data in the infolist item.
* Add completion hook data in the infolist item.
*
* Returns:
* Return:
* 1: OK
* 0: error
*/
@@ -237,7 +237,7 @@ hook_completion_add_to_infolist (struct t_infolist_item *item,
}
/*
* Prints completion hook data in WeeChat log file (usually for crash dump).
* Print completion hook data in WeeChat log file (usually for crash dump).
*/
void
src/core/hook/hook-config.c
+9 -9
View File
@@ -38,7 +38,7 @@
/*
* Returns description of hook.
* Return description of hook.
*
* Note: result must be freed after use.
*/
@@ -50,9 +50,9 @@ hook_config_get_description (struct t_hook *hook)
}
/*
* Hooks a configuration option.
* Hook a configuration option.
*
* Returns pointer to new hook, NULL if error.
* Return pointer to new hook, NULL if error.
*/
struct t_hook *
@@ -95,7 +95,7 @@ hook_config (struct t_weechat_plugin *plugin, const char *option,
}
/*
* Executes a config hook.
* Execute a config hook.
*/
void
@@ -132,7 +132,7 @@ hook_config_exec (const char *option, const char *value)
}
/*
* Frees data in a config hook.
* Free data in a config hook.
*/
void
@@ -152,7 +152,7 @@ hook_config_free_data (struct t_hook *hook)
}
/*
* Returns hdata for config hook.
* Return hdata for config hook.
*/
struct t_hdata *
@@ -175,9 +175,9 @@ hook_config_hdata_hook_config_cb (const void *pointer, void *data,
}
/*
* Adds config hook data in the infolist item.
* Add config hook data in the infolist item.
*
* Returns:
* Return:
* 1: OK
* 0: error
*/
@@ -198,7 +198,7 @@ hook_config_add_to_infolist (struct t_infolist_item *item,
}
/*
* Prints config hook data in WeeChat log file (usually for crash dump).
* Print config hook data in WeeChat log file (usually for crash dump).
*/
void
src/core/hook/hook-connect.c
+10 -10
View File
@@ -42,7 +42,7 @@
/*
* Returns description of hook.
* Return description of hook.
*
* Note: result must be freed after use.
*/
@@ -63,9 +63,9 @@ hook_connect_get_description (struct t_hook *hook)
}
/*
* Hooks a connection to a peer (using fork).
* Hook a connection to a peer (using fork).
*
* Returns pointer to new hook, NULL if error.
* Return pointer to new hook, NULL if error.
*/
struct t_hook *
@@ -140,7 +140,7 @@ hook_connect (struct t_weechat_plugin *plugin, const char *proxy,
}
/*
* Verifies certificates.
* Verify certificates.
*/
int
@@ -173,7 +173,7 @@ hook_connect_gnutls_verify_certificates (gnutls_session_t tls_session)
}
/*
* Sets certificates.
* Set certificates.
*/
int
@@ -210,7 +210,7 @@ hook_connect_gnutls_set_certificates (gnutls_session_t tls_session,
}
/*
* Frees data in a connect hook.
* Free data in a connect hook.
*/
void
@@ -314,7 +314,7 @@ hook_connect_free_data (struct t_hook *hook)
}
/*
* Returns hdata for connect hook.
* Return hdata for connect hook.
*/
struct t_hdata *
@@ -360,9 +360,9 @@ hook_connect_hdata_hook_connect_cb (const void *pointer, void *data,
}
/*
* Adds connect hook data in the infolist item.
* Add connect hook data in the infolist item.
*
* Returns:
* Return:
* 1: OK
* 0: error
*/
@@ -421,7 +421,7 @@ hook_connect_add_to_infolist (struct t_infolist_item *item,
}
/*
* Prints connect hook data in WeeChat log file (usually for crash dump).
* Print connect hook data in WeeChat log file (usually for crash dump).
*/
void
src/core/hook/hook-fd.c
+14 -14
View File
@@ -45,7 +45,7 @@ int hook_fd_pollfd_count = 0; /* number of file descriptors */
/*
* Returns description of hook.
* Return description of hook.
*
* Note: result must be freed after use.
*/
@@ -67,9 +67,9 @@ hook_fd_get_description (struct t_hook *hook)
}
/*
* Searches for a fd hook in list.
* Search for a fd hook in list.
*
* Returns pointer to hook found, NULL if not found.
* Return pointer to hook found, NULL if not found.
*/
struct t_hook *
@@ -89,7 +89,7 @@ hook_fd_search (int fd)
}
/*
* Reallocates the "struct pollfd" array for poll().
* Reallocate the "struct pollfd" array for poll().
*/
void
@@ -150,9 +150,9 @@ hook_fd_remove_cb (struct t_hook *hook)
}
/*
* Hooks a fd event.
* Hook a fd event.
*
* Returns pointer to new hook, NULL if error.
* Return pointer to new hook, NULL if error.
*/
struct t_hook *
@@ -199,9 +199,9 @@ hook_fd (struct t_weechat_plugin *plugin, int fd, int flag_read,
}
/*
* Executes fd hooks:
* - poll() on fie descriptors
* - call of hook fd callbacks if needed.
* Execute fd hooks:
* - poll() on fie descriptors
* - call of hook fd callbacks if needed.
*/
void
@@ -300,7 +300,7 @@ hook_fd_exec (void)
}
/*
* Frees data in a fd hook.
* Free data in a fd hook.
*/
void
@@ -314,7 +314,7 @@ hook_fd_free_data (struct t_hook *hook)
}
/*
* Returns hdata for fd hook.
* Return hdata for fd hook.
*/
struct t_hdata *
@@ -338,9 +338,9 @@ hook_fd_hdata_hook_fd_cb (const void *pointer, void *data, const char *hdata_nam
}
/*
* Adds fd hook data in the infolist item.
* Add fd hook data in the infolist item.
*
* Returns:
* Return:
* 1: OK
* 0: error
*/
@@ -365,7 +365,7 @@ hook_fd_add_to_infolist (struct t_infolist_item *item,
}
/*
* Prints fd hook data in WeeChat log file (usually for crash dump).
* Print fd hook data in WeeChat log file (usually for crash dump).
*/
void
src/core/hook/hook-focus.c
+11 -11
View File
@@ -39,7 +39,7 @@
/*
* Returns description of hook.
* Return description of hook.
*
* Note: result must be freed after use.
*/
@@ -51,9 +51,9 @@ hook_focus_get_description (struct t_hook *hook)
}
/*
* Hooks a focus.
* Hook a focus.
*
* Returns pointer to new hook, NULL if error.
* Return pointer to new hook, NULL if error.
*/
struct t_hook *
@@ -96,7 +96,7 @@ hook_focus (struct t_weechat_plugin *plugin,
}
/*
* Adds keys of a hashtable into another.
* Add keys of a hashtable into another.
*/
void
@@ -116,7 +116,7 @@ hook_focus_hashtable_map_cb (void *data,
}
/*
* Adds keys of a hashtable into another (adding suffix "2" to keys).
* Add keys of a hashtable into another (adding suffix "2" to keys).
*/
void
@@ -143,7 +143,7 @@ hook_focus_hashtable_map2_cb (void *data,
}
/*
* Gets data for focus on (x,y) on screen.
* Get data for focus on (x,y) on screen.
*
* Argument hashtable_focus2 is not NULL only for a mouse gesture (it's for
* point where mouse button has been released).
@@ -276,7 +276,7 @@ hook_focus_get_data (struct t_hashtable *hashtable_focus1,
}
/*
* Frees data in a focus hook.
* Free data in a focus hook.
*/
void
@@ -296,7 +296,7 @@ hook_focus_free_data (struct t_hook *hook)
}
/*
* Returns hdata for focus hook.
* Return hdata for focus hook.
*/
struct t_hdata *
@@ -319,9 +319,9 @@ hook_focus_hdata_hook_focus_cb (const void *pointer, void *data,
}
/*
* Adds focus hook data in the infolist item.
* Add focus hook data in the infolist item.
*
* Returns:
* Return:
* 1: OK
* 0: error
*/
@@ -342,7 +342,7 @@ hook_focus_add_to_infolist (struct t_infolist_item *item,
}
/*
* Prints focus hook data in WeeChat log file (usually for crash dump).
* Print focus hook data in WeeChat log file (usually for crash dump).
*/
void
src/core/hook/hook-hdata.c
+9 -9
View File
@@ -39,7 +39,7 @@
/*
* Returns description of hook.
* Return description of hook.
*
* Note: result must be freed after use.
*/
@@ -51,9 +51,9 @@ hook_hdata_get_description (struct t_hook *hook)
}
/*
* Hooks a hdata.
* Hook a hdata.
*
* Returns pointer to new hook, NULL if error.
* Return pointer to new hook, NULL if error.
*/
struct t_hook *
@@ -98,7 +98,7 @@ hook_hdata (struct t_weechat_plugin *plugin, const char *hdata_name,
}
/*
* Gets hdata via hdata hook.
* Get hdata via hdata hook.
*/
struct t_hdata *
@@ -153,7 +153,7 @@ hook_hdata_get (struct t_weechat_plugin *plugin, const char *hdata_name)
}
/*
* Frees data in a hdata hook.
* Free data in a hdata hook.
*/
void
@@ -178,7 +178,7 @@ hook_hdata_free_data (struct t_hook *hook)
}
/*
* Returns hdata for hdata hook.
* Return hdata for hdata hook.
*/
struct t_hdata *
@@ -202,9 +202,9 @@ hook_hdata_hdata_hook_hdata_cb (const void *pointer, void *data,
}
/*
* Adds hdata hook data in the infolist item.
* Add hdata hook data in the infolist item.
*
* Returns:
* Return:
* 1: OK
* 0: error
*/
@@ -232,7 +232,7 @@ hook_hdata_add_to_infolist (struct t_infolist_item *item,
}
/*
* Prints hdata hook data in WeeChat log file (usually for crash dump).
* Print hdata hook data in WeeChat log file (usually for crash dump).
*/
void
src/core/hook/hook-hsignal.c
+11 -11
View File
@@ -39,7 +39,7 @@
/*
* Returns description of hook.
* Return description of hook.
*
* Note: result must be freed after use.
*/
@@ -52,9 +52,9 @@ hook_hsignal_get_description (struct t_hook *hook)
}
/*
* Hooks a hsignal (signal with hashtable).
* Hook a hsignal (signal with hashtable).
*
* Returns pointer to new hook, NULL if error.
* Return pointer to new hook, NULL if error.
*/
struct t_hook *
@@ -103,10 +103,10 @@ hook_hsignal (struct t_weechat_plugin *plugin, const char *signal,
}
/*
* Checks if a hooked hsignal matches a signal sent: it matches if at least
* Check if a hooked hsignal matches a signal sent: it matches if at least
* one of the signal masks are matching the signal sent.
*
* Returns:
* Return:
* 1: hook matches signal sent
* 0: hook does not match signal sent
*/
@@ -126,7 +126,7 @@ hook_hsignal_match (const char *signal, struct t_hook *hook)
}
/*
* Sends a hsignal (signal with hashtable).
* Send a hsignal (signal with hashtable).
*/
int
@@ -185,7 +185,7 @@ hook_hsignal_send (const char *signal, struct t_hashtable *hashtable)
}
/*
* Frees data in a hsignal hook.
* Free data in a hsignal hook.
*/
void
@@ -206,7 +206,7 @@ hook_hsignal_free_data (struct t_hook *hook)
}
/*
* Returns hdata for hsignal hook.
* Return hdata for hsignal hook.
*/
struct t_hdata *
@@ -230,9 +230,9 @@ hook_hsignal_hdata_hook_hsignal_cb (const void *pointer, void *data,
}
/*
* Adds hsignal hook data in the infolist item.
* Add hsignal hook data in the infolist item.
*
* Returns:
* Return:
* 1: OK
* 0: error
*/
@@ -264,7 +264,7 @@ hook_hsignal_add_to_infolist (struct t_infolist_item *item,
}
/*
* Prints hsignal hook data in WeeChat log file (usually for crash dump).
* Print hsignal hook data in WeeChat log file (usually for crash dump).
*/
void
src/core/hook/hook-info-hashtable.c
+9 -9
View File
@@ -38,7 +38,7 @@
/*
* Returns description of hook.
* Return description of hook.
*
* Note: result must be freed after use.
*/
@@ -50,9 +50,9 @@ hook_info_hashtable_get_description (struct t_hook *hook)
}
/*
* Hooks an info using hashtable.
* Hook an info using hashtable.
*
* Returns pointer to new hook, NULL if error.
* Return pointer to new hook, NULL if error.
*/
struct t_hook *
@@ -102,7 +102,7 @@ hook_info_hashtable (struct t_weechat_plugin *plugin, const char *info_name,
}
/*
* Gets info (as hashtable) via info hook.
* Get info (as hashtable) via info hook.
*/
struct t_hashtable *
@@ -152,7 +152,7 @@ hook_info_get_hashtable (struct t_weechat_plugin *plugin, const char *info_name,
}
/*
* Frees data in an info_hashtable hook.
* Free data in an info_hashtable hook.
*/
void
@@ -187,7 +187,7 @@ hook_info_hashtable_free_data (struct t_hook *hook)
}
/*
* Returns hdata for info_hashtable hook.
* Return hdata for info_hashtable hook.
*/
struct t_hdata *
@@ -214,9 +214,9 @@ hook_info_hashtable_hdata_hook_info_hashtable_cb (const void *pointer,
}
/*
* Adds info_hashtable hook data in the infolist item.
* Add info_hashtable hook data in the infolist item.
*
* Returns:
* Return:
* 1: OK
* 0: error
*/
@@ -258,7 +258,7 @@ hook_info_hashtable_add_to_infolist (struct t_infolist_item *item,
}
/*
* Prints info_hashtable hook data in WeeChat log file (usually for crash dump).
* Print info_hashtable hook data in WeeChat log file (usually for crash dump).
*/
void
src/core/hook/hook-info.c
+9 -9
View File
@@ -38,7 +38,7 @@
/*
* Returns description of hook.
* Return description of hook.
*
* Note: result must be freed after use.
*/
@@ -50,9 +50,9 @@ hook_info_get_description (struct t_hook *hook)
}
/*
* Hooks an info.
* Hook an info.
*
* Returns pointer to new hook, NULL if error.
* Return pointer to new hook, NULL if error.
*/
struct t_hook *
@@ -99,7 +99,7 @@ hook_info (struct t_weechat_plugin *plugin, const char *info_name,
}
/*
* Gets info (as string) via info hook.
* Get info (as string) via info hook.
*
* Note: result must be freed after use.
*/
@@ -151,7 +151,7 @@ hook_info_get (struct t_weechat_plugin *plugin, const char *info_name,
}
/*
* Frees data in an info hook.
* Free data in an info hook.
*/
void
@@ -181,7 +181,7 @@ hook_info_free_data (struct t_hook *hook)
}
/*
* Returns hdata for info hook.
* Return hdata for info hook.
*/
struct t_hdata *
@@ -206,9 +206,9 @@ hook_info_hdata_hook_info_cb (const void *pointer, void *data,
}
/*
* Adds info hook data in the infolist item.
* Add info hook data in the infolist item.
*
* Returns:
* Return:
* 1: OK
* 0: error
*/
@@ -243,7 +243,7 @@ hook_info_add_to_infolist (struct t_infolist_item *item,
}
/*
* Prints info hook data in WeeChat log file (usually for crash dump).
* Print info hook data in WeeChat log file (usually for crash dump).
*/
void
src/core/hook/hook-infolist.c
+9 -9
View File
@@ -38,7 +38,7 @@
/*
* Returns description of hook.
* Return description of hook.
*
* Note: result must be freed after use.
*/
@@ -50,9 +50,9 @@ hook_infolist_get_description (struct t_hook *hook)
}
/*
* Hooks an infolist.
* Hook an infolist.
*
* Returns pointer to new hook, NULL if error.
* Return pointer to new hook, NULL if error.
*/
struct t_hook *
@@ -102,7 +102,7 @@ hook_infolist (struct t_weechat_plugin *plugin, const char *infolist_name,
}
/*
* Gets an infolist via infolist hook.
* Get an infolist via infolist hook.
*/
struct t_infolist *
@@ -153,7 +153,7 @@ hook_infolist_get (struct t_weechat_plugin *plugin, const char *infolist_name,
}
/*
* Frees data in an infolist hook.
* Free data in an infolist hook.
*/
void
@@ -188,7 +188,7 @@ hook_infolist_free_data (struct t_hook *hook)
}
/*
* Returns hdata for infolist hook.
* Return hdata for infolist hook.
*/
struct t_hdata *
@@ -214,9 +214,9 @@ hook_infolist_hdata_hook_infolist_cb (const void *pointer, void *data,
}
/*
* Adds infolist hook data in the infolist item.
* Add infolist hook data in the infolist item.
*
* Returns:
* Return:
* 1: OK
* 0: error
*/
@@ -258,7 +258,7 @@ hook_infolist_add_to_infolist (struct t_infolist_item *item,
}
/*
* Prints infolist hook data in WeeChat log file (usually for crash dump).
* Print infolist hook data in WeeChat log file (usually for crash dump).
*/
void
src/core/hook/hook-line.c
+9 -9
View File
@@ -41,7 +41,7 @@
/*
* Returns description of hook.
* Return description of hook.
*
* Note: result must be freed after use.
*/
@@ -61,9 +61,9 @@ hook_line_get_description (struct t_hook *hook)
}
/*
* Hooks a line added in a buffer.
* Hook a line added in a buffer.
*
* Returns pointer to new hook, NULL if error.
* Return pointer to new hook, NULL if error.
*/
struct t_hook *
@@ -121,7 +121,7 @@ hook_line (struct t_weechat_plugin *plugin, const char *buffer_type,
}
/*
* Executes a line hook and updates the line data.
* Execute a line hook and updates the line data.
*/
void
@@ -212,7 +212,7 @@ hook_line_exec (struct t_gui_line *line)
}
/*
* Frees data in a line hook.
* Free data in a line hook.
*/
void
@@ -237,7 +237,7 @@ hook_line_free_data (struct t_hook *hook)
}
/*
* Returns hdata for line hook.
* Return hdata for line hook.
*/
struct t_hdata *
@@ -264,9 +264,9 @@ hook_line_hdata_hook_line_cb (const void *pointer, void *data,
}
/*
* Adds line hook data in the infolist item.
* Add line hook data in the infolist item.
*
* Returns:
* Return:
* 1: OK
* 0: error
*/
@@ -295,7 +295,7 @@ hook_line_add_to_infolist (struct t_infolist_item *item,
}
/*
* Prints line hook data in WeeChat log file (usually for crash dump).
* Print line hook data in WeeChat log file (usually for crash dump).
*/
void
src/core/hook/hook-modifier.c
+9 -9
View File
@@ -38,7 +38,7 @@
/*
* Returns description of hook.
* Return description of hook.
*
* Note: result must be freed after use.
*/
@@ -50,9 +50,9 @@ hook_modifier_get_description (struct t_hook *hook)
}
/*
* Hooks a modifier.
* Hook a modifier.
*
* Returns pointer to new hook, NULL if error.
* Return pointer to new hook, NULL if error.
*/
struct t_hook *
@@ -94,7 +94,7 @@ hook_modifier (struct t_weechat_plugin *plugin, const char *modifier,
}
/*
* Executes a modifier hook.
* Execute a modifier hook.
*
* Note: result must be freed after use.
*/
@@ -164,7 +164,7 @@ hook_modifier_exec (struct t_weechat_plugin *plugin, const char *modifier,
}
/*
* Frees data in a modifier hook.
* Free data in a modifier hook.
*/
void
@@ -184,7 +184,7 @@ hook_modifier_free_data (struct t_hook *hook)
}
/*
* Returns hdata for modifier hook.
* Return hdata for modifier hook.
*/
struct t_hdata *
@@ -207,9 +207,9 @@ hook_modifier_hdata_hook_modifier_cb (const void *pointer, void *data,
}
/*
* Adds modifier hook data in the infolist item.
* Add modifier hook data in the infolist item.
*
* Returns:
* Return:
* 1: OK
* 0: error
*/
@@ -230,7 +230,7 @@ hook_modifier_add_to_infolist (struct t_infolist_item *item,
}
/*
* Prints modifier hook data in WeeChat log file (usually for crash dump).
* Print modifier hook data in WeeChat log file (usually for crash dump).
*/
void
src/core/hook/hook-print.c
+9 -9
View File
@@ -41,7 +41,7 @@
/*
* Returns description of hook.
* Return description of hook.
*
* Note: result must be freed after use.
*/
@@ -73,9 +73,9 @@ hook_print_get_description (struct t_hook *hook)
}
/*
* Hooks a message printed by WeeChat.
* Hook a message printed by WeeChat.
*
* Returns pointer to new hook, NULL if error.
* Return pointer to new hook, NULL if error.
*/
struct t_hook *
@@ -118,7 +118,7 @@ hook_print (struct t_weechat_plugin *plugin, struct t_gui_buffer *buffer,
}
/*
* Executes a print hook.
* Execute a print hook.
*/
void
@@ -190,7 +190,7 @@ hook_print_exec (struct t_gui_buffer *buffer, struct t_gui_line *line)
}
/*
* Frees data in a print hook.
* Free data in a print hook.
*/
void
@@ -215,7 +215,7 @@ hook_print_free_data (struct t_hook *hook)
}
/*
* Returns hdata for print hook.
* Return hdata for print hook.
*/
struct t_hdata *
@@ -242,9 +242,9 @@ hook_print_hdata_hook_print_cb (const void *pointer, void *data,
}
/*
* Adds print hook data in the infolist item.
* Add print hook data in the infolist item.
*
* Returns:
* Return:
* 1: OK
* 0: error
*/
@@ -273,7 +273,7 @@ hook_print_add_to_infolist (struct t_infolist_item *item,
}
/*
* Prints print hook data in WeeChat log file (usually for crash dump).
* Print print hook data in WeeChat log file (usually for crash dump).
*/
void
src/core/hook/hook-process.c
+20 -21
View File
@@ -53,7 +53,7 @@ void hook_process_run (struct t_hook *hook_process);
/*
* Returns description of hook.
* Return description of hook.
*
* Note: result must be freed after use.
*/
@@ -72,9 +72,9 @@ hook_process_get_description (struct t_hook *hook)
}
/*
* Hooks a process (using fork) with options in hashtable.
* Hook a process (using fork) with options in hashtable.
*
* Returns pointer to new hook, NULL if error.
* Return pointer to new hook, NULL if error.
*/
struct t_hook *
@@ -188,9 +188,9 @@ error:
}
/*
* Hooks a process (using fork).
* Hook a process (using fork).
*
* Returns pointer to new hook, NULL if error.
* Return pointer to new hook, NULL if error.
*/
struct t_hook *
@@ -206,7 +206,7 @@ hook_process (struct t_weechat_plugin *plugin,
}
/*
* Child process for hook process: executes command and returns string result
* Child process for hook process: execute command and return string result
* into pipe for WeeChat process.
*/
@@ -379,7 +379,7 @@ hook_process_child (struct t_hook *hook_process)
}
/*
* Sends buffers (stdout/stderr) to callback.
* Send buffers (stdout/stderr) to callback.
*/
void
@@ -412,7 +412,7 @@ hook_process_send_buffers (struct t_hook *hook_process, int callback_rc)
}
/*
* Adds some data to buffer (stdout or stderr).
* Add some data to buffer (stdout or stderr).
*/
void
@@ -429,7 +429,7 @@ hook_process_add_to_buffer (struct t_hook *hook_process, int index_buffer,
}
/*
* Reads process output (stdout or stderr) from child process.
* Read process output (stdout or stderr) from child process.
*/
void
@@ -462,7 +462,7 @@ hook_process_child_read (struct t_hook *hook_process, int fd,
}
/*
* Reads process output (stdout) from child process.
* Read process output (stdout) from child process.
*/
int
@@ -481,7 +481,7 @@ hook_process_child_read_stdout_cb (const void *pointer, void *data, int fd)
}
/*
* Reads process output (stderr) from child process.
* Read process output (stderr) from child process.
*/
int
@@ -500,7 +500,7 @@ hook_process_child_read_stderr_cb (const void *pointer, void *data, int fd)
}
/*
* Reads process output from child process until EOF
* Read process output from child process until EOF
* (called when the child process has ended).
*/
@@ -576,7 +576,7 @@ hook_process_child_read_until_eof (struct t_hook *hook_process)
}
/*
* Checks if child process is still alive.
* Check if child process is still alive.
*/
int
@@ -635,8 +635,7 @@ hook_process_timer_cb (const void *pointer, void *data, int remaining_calls)
}
/*
* Executes process command in child, and read data in current process,
* with fd hook.
* Execute process command in child, and read data in current process, with fd hook.
*/
void
@@ -788,7 +787,7 @@ error:
}
/*
* Executes all process commands pending.
* Execute all process commands pending.
*/
void
@@ -822,7 +821,7 @@ hook_process_exec (void)
}
/*
* Frees data in a process hook.
* Free data in a process hook.
*/
void
@@ -918,7 +917,7 @@ hook_process_free_data (struct t_hook *hook)
}
/*
* Returns hdata for process hook.
* Return hdata for process hook.
*/
struct t_hdata *
@@ -952,9 +951,9 @@ hook_process_hdata_hook_process_cb (const void *pointer, void *data,
}
/*
* Adds process hook data in the infolist item.
* Add process hook data in the infolist item.
*
* Returns:
* Return:
* 1: OK
* 0: error
*/
@@ -1003,7 +1002,7 @@ hook_process_add_to_infolist (struct t_infolist_item *item,
}
/*
* Prints process hook data in WeeChat log file (usually for crash dump).
* Print process hook data in WeeChat log file (usually for crash dump).
*/
void
src/core/hook/hook-signal.c
+12 -12
View File
@@ -38,7 +38,7 @@
/*
* Returns description of hook.
* Return description of hook.
*
* Note: result must be freed after use.
*/
@@ -51,9 +51,9 @@ hook_signal_get_description (struct t_hook *hook)
}
/*
* Hooks a signal.
* Hook a signal.
*
* Returns pointer to new hook, NULL if error.
* Return pointer to new hook, NULL if error.
*/
struct t_hook *
@@ -102,10 +102,10 @@ hook_signal (struct t_weechat_plugin *plugin, const char *signal,
}
/*
* Checks if a hooked signal matches a signal sent: it matches if at least
* Check if a hooked signal matches a signal sent: it matches if at least
* one of the signal masks are matching the signal sent.
*
* Returns:
* Return:
* 1: hook matches signal sent
* 0: hook does not match signal sent
*/
@@ -125,7 +125,7 @@ hook_signal_match (const char *signal, struct t_hook *hook)
}
/*
* Extracts flags from signal and returns flags and pointer to start of signal.
* Extract flags from signal and return flags and pointer to start of signal.
*/
void
@@ -176,7 +176,7 @@ hook_signal_extract_flags (const char *signal, const char **ptr_signal,
}
/*
* Sends a signal.
* Send a signal.
*/
int
@@ -236,7 +236,7 @@ hook_signal_send (const char *signal, const char *type_data, void *signal_data)
}
/*
* Frees data in a signal hook.
* Free data in a signal hook.
*/
void
@@ -257,7 +257,7 @@ hook_signal_free_data (struct t_hook *hook)
}
/*
* Returns hdata for signal hook.
* Return hdata for signal hook.
*/
struct t_hdata *
@@ -281,9 +281,9 @@ hook_signal_hdata_hook_signal_cb (const void *pointer, void *data,
}
/*
* Adds signal hook data in the infolist item.
* Add signal hook data in the infolist item.
*
* Returns:
* Return:
* 1: OK
* 0: error
*/
@@ -315,7 +315,7 @@ hook_signal_add_to_infolist (struct t_infolist_item *item,
}
/*
* Prints signal hook data in WeeChat log file (usually for crash dump).
* Print signal hook data in WeeChat log file (usually for crash dump).
*/
void
src/core/hook/hook-timer.c
+13 -13
View File
@@ -43,7 +43,7 @@ time_t hook_last_system_time = 0; /* used to detect system clock skew */
/*
* Returns description of hook.
* Return description of hook.
*
* Note: result must be freed after use.
*/
@@ -80,7 +80,7 @@ hook_timer_get_description (struct t_hook *hook)
}
/*
* Initializes a timer hook.
* Initialize a timer hook.
*/
void
@@ -136,9 +136,9 @@ hook_timer_init (struct t_hook *hook)
}
/*
* Hooks a timer.
* Hook a timer.
*
* Returns pointer to new hook, NULL if error.
* Return pointer to new hook, NULL if error.
*/
struct t_hook *
@@ -180,8 +180,8 @@ hook_timer (struct t_weechat_plugin *plugin, long interval, int align_second,
}
/*
* Checks if system clock is older than previous call to this function (that
* means new time is lower than in past). If yes, adjusts all timers to current
* Check if system clock is older than previous call to this function (that
* means new time is lower than in past). If yes, adjust all timers to current
* time.
*/
@@ -222,7 +222,7 @@ hook_timer_check_system_clock (void)
}
/*
* Returns time until next timeout (in milliseconds).
* Return time until next timeout (in milliseconds).
*/
int
@@ -300,7 +300,7 @@ end:
}
/*
* Executes timer hooks.
* Execute timer hooks.
*/
void
@@ -361,7 +361,7 @@ hook_timer_exec (void)
}
/*
* Frees data in a timer hook.
* Free data in a timer hook.
*/
void
@@ -375,7 +375,7 @@ hook_timer_free_data (struct t_hook *hook)
}
/*
* Returns hdata for timer hook.
* Return hdata for timer hook.
*/
struct t_hdata *
@@ -404,9 +404,9 @@ hook_timer_hdata_hook_timer_cb (const void *pointer, void *data,
}
/*
* Adds timer hook data in the infolist item.
* Add timer hook data in the infolist item.
*
* Returns:
* Return:
* 1: OK
* 0: error
*/
@@ -442,7 +442,7 @@ hook_timer_add_to_infolist (struct t_infolist_item *item,
}
/*
* Prints timer hook data in WeeChat log file (usually for crash dump).
* Print timer hook data in WeeChat log file (usually for crash dump).
*/
void
src/core/hook/hook-url.c
+12 -12
View File
@@ -47,7 +47,7 @@
/*
* Returns description of hook.
* Return description of hook.
*
* Note: result must be freed after use.
*/
@@ -66,7 +66,7 @@ hook_url_get_description (struct t_hook *hook)
}
/*
* Displays keys and values of a hashtable.
* Display keys and values of a hashtable.
*/
void
@@ -83,7 +83,7 @@ hook_url_hashtable_map_cb (void *data, struct t_hashtable *hashtable,
}
/*
* Runs callback of url hook.
* Run callback of url hook.
*/
void
@@ -154,7 +154,7 @@ hook_url_transfer_thread (void *hook_pointer)
}
/*
* Checks if thread is still alive.
* Check if thread is still alive.
*/
int
@@ -218,7 +218,7 @@ hook_url_timer_cb (const void *pointer, void *data, int remaining_calls)
}
/*
* Starts transfer for an URL hook.
* Start transfer for an URL hook.
*/
void
@@ -286,9 +286,9 @@ hook_url_transfer (struct t_hook *hook)
}
/*
* Hooks a URL.
* Hook a URL.
*
* Returns pointer to new hook, NULL if error.
* Return pointer to new hook, NULL if error.
*/
struct t_hook *
@@ -358,7 +358,7 @@ error:
}
/*
* Frees data in a url hook.
* Free data in a url hook.
*/
void
@@ -422,7 +422,7 @@ hook_url_free_data (struct t_hook *hook)
}
/*
* Returns hdata for url hook.
* Return hdata for url hook.
*/
struct t_hdata *
@@ -452,9 +452,9 @@ hook_url_hdata_hook_url_cb (const void *pointer, void *data,
}
/*
* Adds url hook data in the infolist item.
* Add url hook data in the infolist item.
*
* Returns:
* Return:
* 1: OK
* 0: error
*/
@@ -489,7 +489,7 @@ hook_url_add_to_infolist (struct t_infolist_item *item,
}
/*
* Prints url hook data in WeeChat log file (usually for crash dump).
* Print url hook data in WeeChat log file (usually for crash dump).
*/
void