mirror of
https://github.com/weechat/weechat.git
synced 2026-06-29 06:16:40 +02:00
core, plugins: fix typos in comments on functions, use imperative
This commit is contained in:
@@ -108,8 +108,7 @@ exec_buffer_close_cb (const void *pointer, void *data,
|
||||
}
|
||||
|
||||
/*
|
||||
* Restore buffer callbacks (input and close) for buffers created by exec
|
||||
* plugin.
|
||||
* Restore buffer callbacks (input and close) for buffers created by exec plugin.
|
||||
*/
|
||||
|
||||
void
|
||||
@@ -140,7 +139,7 @@ exec_buffer_set_callbacks (void)
|
||||
}
|
||||
|
||||
/*
|
||||
* Creates a new exec buffer for a command.
|
||||
* Create a new exec buffer for a command.
|
||||
*/
|
||||
|
||||
struct t_gui_buffer *
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
|
||||
/*
|
||||
* Displays a list of executed commands.
|
||||
* Display a list of executed commands.
|
||||
*/
|
||||
|
||||
void
|
||||
@@ -139,10 +139,10 @@ exec_command_list (void)
|
||||
}
|
||||
|
||||
/*
|
||||
* Searches a running command by id, and displays an error if command is not
|
||||
* Search a running command by id, and displays an error if command is not
|
||||
* found or not running anymore.
|
||||
*
|
||||
* Returns the command found, or NULL if not found or not running.
|
||||
* Return the command found, or NULL if not found or not running.
|
||||
*/
|
||||
|
||||
struct t_exec_cmd *
|
||||
@@ -175,7 +175,7 @@ exec_command_search_running_id (const char *id)
|
||||
/*
|
||||
* Parse command options.
|
||||
*
|
||||
* Returns:
|
||||
* Return:
|
||||
* 1: options parsed successfully
|
||||
* 0: error parsing options
|
||||
*/
|
||||
@@ -396,9 +396,9 @@ exec_command_parse_options (struct t_exec_cmd_options *cmd_options,
|
||||
}
|
||||
|
||||
/*
|
||||
* Runs a command.
|
||||
* Run a command.
|
||||
*
|
||||
* Returns:
|
||||
* Return:
|
||||
* WEECHAT_RC_OK: command run successfully
|
||||
* WEECHAT_RC_ERROR: error running command
|
||||
*/
|
||||
@@ -813,7 +813,7 @@ exec_command_exec (const void *pointer, void *data,
|
||||
}
|
||||
|
||||
/*
|
||||
* Hooks exec commands.
|
||||
* Hook exec commands.
|
||||
*/
|
||||
|
||||
void
|
||||
|
||||
@@ -30,7 +30,7 @@
|
||||
|
||||
|
||||
/*
|
||||
* Adds executed commands ids to completion list.
|
||||
* Add executed commands ids to completion list.
|
||||
*/
|
||||
|
||||
int
|
||||
@@ -66,7 +66,7 @@ exec_completion_commands_ids_cb (const void *pointer, void *data,
|
||||
}
|
||||
|
||||
/*
|
||||
* Hooks completions.
|
||||
* Hook completions.
|
||||
*/
|
||||
|
||||
void
|
||||
|
||||
@@ -78,7 +78,7 @@ exec_config_change_command_default_options (const void *pointer, void *data,
|
||||
}
|
||||
|
||||
/*
|
||||
* Reloads exec configuration file.
|
||||
* Reload exec configuration file.
|
||||
*/
|
||||
|
||||
int
|
||||
@@ -93,9 +93,9 @@ exec_config_reload_cb (const void *pointer, void *data,
|
||||
}
|
||||
|
||||
/*
|
||||
* Initializes exec configuration file.
|
||||
* Initialize exec configuration file.
|
||||
*
|
||||
* Returns:
|
||||
* Return:
|
||||
* 1: OK
|
||||
* 0: error
|
||||
*/
|
||||
@@ -179,7 +179,7 @@ exec_config_init (void)
|
||||
}
|
||||
|
||||
/*
|
||||
* Reads exec configuration file.
|
||||
* Read exec configuration file.
|
||||
*/
|
||||
|
||||
int
|
||||
@@ -189,7 +189,7 @@ exec_config_read (void)
|
||||
}
|
||||
|
||||
/*
|
||||
* Writes exec configuration file.
|
||||
* Write exec configuration file.
|
||||
*/
|
||||
|
||||
int
|
||||
@@ -199,7 +199,7 @@ exec_config_write (void)
|
||||
}
|
||||
|
||||
/*
|
||||
* Frees exec configuration.
|
||||
* Free exec configuration.
|
||||
*/
|
||||
|
||||
void
|
||||
|
||||
+15
-15
@@ -52,9 +52,9 @@ char *exec_color_string[EXEC_NUM_COLORS] =
|
||||
|
||||
|
||||
/*
|
||||
* Searches for a color action name.
|
||||
* Search for a color action name.
|
||||
*
|
||||
* Returns index of color in enum t_exec_color, -1 if not found.
|
||||
* Return index of color in enum t_exec_color, -1 if not found.
|
||||
*/
|
||||
|
||||
int
|
||||
@@ -76,9 +76,9 @@ exec_search_color (const char *color)
|
||||
}
|
||||
|
||||
/*
|
||||
* Searches for an executed command by id, which can be a number or a name.
|
||||
* Search for an executed command by id, which can be a number or a name.
|
||||
*
|
||||
* Returns pointer to executed command found, NULL if not found.
|
||||
* Return pointer to executed command found, NULL if not found.
|
||||
*/
|
||||
|
||||
struct t_exec_cmd *
|
||||
@@ -113,7 +113,7 @@ exec_search_by_id (const char *id)
|
||||
}
|
||||
|
||||
/*
|
||||
* Adds a command in list of executed commands.
|
||||
* Add a command in list of executed commands.
|
||||
*/
|
||||
|
||||
struct t_exec_cmd *
|
||||
@@ -195,9 +195,9 @@ exec_timer_delete_cb (const void *pointer, void *data, int remaining_calls)
|
||||
}
|
||||
|
||||
/*
|
||||
* Decodes colors in a string (from stdout/stderr).
|
||||
* Decode colors in a string (from stdout/stderr).
|
||||
*
|
||||
* Returns string with colors as-is, decoded or removed.
|
||||
* Return string with colors as-is, decoded or removed.
|
||||
*
|
||||
* Note: result must be freed after use.
|
||||
*/
|
||||
@@ -237,7 +237,7 @@ exec_decode_color (struct t_exec_cmd *exec_cmd, const char *string)
|
||||
}
|
||||
|
||||
/*
|
||||
* Displays a line of output.
|
||||
* Display a line of output.
|
||||
*/
|
||||
|
||||
void
|
||||
@@ -360,7 +360,7 @@ exec_display_line (struct t_exec_cmd *exec_cmd, struct t_gui_buffer *buffer,
|
||||
}
|
||||
|
||||
/*
|
||||
* Concatenates some text to stdout/stderr of a command.
|
||||
* Concatenate some text to stdout/stderr of a command.
|
||||
*/
|
||||
|
||||
void
|
||||
@@ -430,7 +430,7 @@ exec_concat_output (struct t_exec_cmd *exec_cmd, struct t_gui_buffer *buffer,
|
||||
}
|
||||
|
||||
/*
|
||||
* Ends a command.
|
||||
* End a command.
|
||||
*/
|
||||
|
||||
void
|
||||
@@ -601,7 +601,7 @@ exec_process_cb (const void *pointer, void *data, const char *command,
|
||||
}
|
||||
|
||||
/*
|
||||
* Deletes a command.
|
||||
* Delete a command.
|
||||
*/
|
||||
|
||||
void
|
||||
@@ -640,7 +640,7 @@ exec_free (struct t_exec_cmd *exec_cmd)
|
||||
}
|
||||
|
||||
/*
|
||||
* Deletes all commands.
|
||||
* Delete all commands.
|
||||
*/
|
||||
|
||||
void
|
||||
@@ -653,7 +653,7 @@ exec_free_all (void)
|
||||
}
|
||||
|
||||
/*
|
||||
* Prints exec infos in WeeChat log file (usually for crash dump).
|
||||
* Print exec infos in WeeChat log file (usually for crash dump).
|
||||
*/
|
||||
|
||||
void
|
||||
@@ -725,7 +725,7 @@ exec_debug_dump_cb (const void *pointer, void *data,
|
||||
}
|
||||
|
||||
/*
|
||||
* Initializes exec plugin.
|
||||
* Initialize exec plugin.
|
||||
*/
|
||||
|
||||
int
|
||||
@@ -757,7 +757,7 @@ weechat_plugin_init (struct t_weechat_plugin *plugin, int argc, char *argv[])
|
||||
}
|
||||
|
||||
/*
|
||||
* Ends exec plugin.
|
||||
* End exec plugin.
|
||||
*/
|
||||
|
||||
int
|
||||
|
||||
Reference in New Issue
Block a user