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

src/plugins/logger/logger-backlog.c

@@ -49,7 +49,7 @@
 
 
 /*
- * Displays a line read from log file.
+ * Display a line read from log file.
  */
 
 void
@@ -135,7 +135,7 @@ logger_backlog_display_line (struct t_gui_buffer *buffer, const char *line)
 }
 
 /*
- * Compares two messages in arraylist.
+ * Compare two messages in arraylist.
  */
 
 int
@@ -152,7 +152,7 @@ logger_backlog_msg_cmp_cb (void *data,
 }
 
 /*
- * Frees a message in arraylist.
+ * Free a message in arraylist.
  */
 
 void
@@ -167,7 +167,7 @@ logger_backlog_msg_free_cb (void *data, struct t_arraylist *arraylist,
 }
 
 /*
- * Groups lines by messages: each line with a timestamp is considered the first
+ * Group lines by messages: each line with a timestamp is considered the first
  * line of a message, and subsequent lines without timestamp are the rest of
  * the message.
  *
@@ -262,7 +262,7 @@ error:
 }
 
 /*
- * Displays backlog for a buffer by reading end of log file.
+ * Display backlog for a buffer by reading end of log file.
  */
 
 void

src/plugins/logger/logger-buffer.c

@@ -47,9 +47,9 @@ struct t_logger_buffer *last_logger_buffer = NULL;
 
 
 /*
- * Checks if a logger buffer pointer is valid.
+ * Check if a logger buffer pointer is valid.
  *
- * Returns:
+ * Return:
  *   1: logger buffer exists
  *   0: logger buffer does not exist
  */
@@ -74,9 +74,9 @@ logger_buffer_valid (struct t_logger_buffer *logger_buffer)
 }
 
 /*
- * Adds a new buffer for logging.
+ * Add a new buffer for logging.
  *
- * Returns pointer to new logger buffer, NULL if error.
+ * Return pointer to new logger buffer, NULL if error.
  */
 
 struct t_logger_buffer *
@@ -121,9 +121,9 @@ logger_buffer_add (struct t_gui_buffer *buffer, int log_level)
 }
 
 /*
- * Searches for logger buffer by buffer pointer.
+ * Search for logger buffer by buffer pointer.
  *
- * Returns pointer to logger buffer found, NULL if not found.
+ * Return pointer to logger buffer found, NULL if not found.
  */
 
 struct t_logger_buffer *
@@ -143,9 +143,9 @@ logger_buffer_search_buffer (struct t_gui_buffer *buffer)
 }
 
 /*
- * Searches for a logger buffer by log filename.
+ * Search for a logger buffer by log filename.
  *
- * Returns pointer to logger buffer found, NULL if not found.
+ * Return pointer to logger buffer found, NULL if not found.
  */
 
 struct t_logger_buffer *
@@ -171,7 +171,7 @@ logger_buffer_search_log_filename (const char *log_filename)
 }
 
 /*
- * Sets log filename for a logger buffer.
+ * Set log filename for a logger buffer.
  */
 
 void
@@ -228,9 +228,9 @@ logger_buffer_set_log_filename (struct t_logger_buffer *logger_buffer)
 }
 
 /*
- * Creates a log file.
+ * Create a log file.
  *
- * Returns:
+ * Return:
  *   1: OK
  *   0: error
  */
@@ -329,7 +329,7 @@ logger_buffer_create_log_file (struct t_logger_buffer *logger_buffer)
 }
 
 /*
- * Compresses a log file, in the child process.
+ * Compress a log file, in the child process.
  */
 
 void
@@ -414,7 +414,7 @@ logger_buffer_compress_cb (const void *pointer, void *data,
 }
 
 /*
- * Rotates a log file if needed (rotation enabled and max size reached).
+ * Rotate a log file if needed (rotation enabled and max size reached).
  *
  * For example if we have these log files:
  *
@@ -604,7 +604,7 @@ logger_buffer_rotate (struct t_logger_buffer *logger_buffer)
 }
 
 /*
- * Writes a line to log file.
+ * Write a line to log file.
  */
 
 void
@@ -643,7 +643,7 @@ logger_buffer_write_line (struct t_logger_buffer *logger_buffer,
 }
 
 /*
- * Stops log for a logger buffer.
+ * Stop log for a logger buffer.
  */
 
 void
@@ -674,7 +674,7 @@ logger_buffer_stop (struct t_logger_buffer *logger_buffer, int write_info_line)
 }
 
 /*
- * Ends log for all buffers.
+ * End log for all buffers.
  */
 
 void
@@ -687,7 +687,7 @@ logger_buffer_stop_all (int write_info_line)
 }
 
 /*
- * Starts logging for a buffer.
+ * Start logging for a buffer.
  */
 
 void
@@ -743,7 +743,7 @@ logger_buffer_start (struct t_gui_buffer *buffer, int write_info_line)
 }
 
 /*
- * Starts logging for all buffers.
+ * Start logging for all buffers.
  */
 
 void
@@ -765,7 +765,7 @@ logger_buffer_start_all (int write_info_line)
 }
 
 /*
- * Flushes all log files.
+ * Flush all log files.
  */
 
 void
@@ -795,7 +795,7 @@ logger_buffer_flush (void)
 }
 
 /*
- * Adjusts log filenames for all buffers.
+ * Adjust log filenames for all buffers.
  *
  * Filename can change if configuration option is changed, or if day of system
  * date has changed.
@@ -839,7 +839,7 @@ logger_buffer_adjust_log_filenames (void)
 }
 
 /*
- * Removes a logger buffer from list.
+ * Remove a logger buffer from list.
  */
 
 void
@@ -887,9 +887,9 @@ logger_buffer_free (struct t_logger_buffer *logger_buffer)
 }
 
 /*
- * Adds a logger buffer in an infolist.
+ * Add a logger buffer in an infolist.
  *
- * Returns:
+ * Return:
  *   1: OK
  *   0: error
  */

src/plugins/logger/logger-command.c

@@ -31,7 +31,7 @@
 
 
 /*
- * Displays logging status for buffers.
+ * Display logging status for buffers.
  */
 
 void
@@ -88,7 +88,7 @@ logger_list (void)
 }
 
 /*
- * Enables/disables logging on a buffer.
+ * Enable/disable logging on a buffer.
  */
 
 void
@@ -159,7 +159,7 @@ logger_command_cb (const void *pointer, void *data,
 }
 
 /*
- * Hooks logger commands.
+ * Hook logger commands.
  */
 
 void

src/plugins/logger/logger-config.c

@@ -78,8 +78,7 @@ unsigned long long logger_config_rotation_size_max = 0;
 
 
 /*
- * Callback for changes on option that require a restart of logging for all
- * buffers.
+ * Callback for changes on option that require a restart of logging for all buffers.
  */
 
 void
@@ -193,7 +192,7 @@ logger_config_flush_delay_change (const void *pointer, void *data,
  * Callback called when option "logger.file.rotation_size_max" is changed,
  * to check if value is valid.
  *
- * Returns:
+ * Return:
  *   1: value is OK
  *   0: value is invalid
  */
@@ -224,7 +223,7 @@ logger_config_rotation_size_max_check (const void *pointer, void *data,
 /*
  * Callback called when option "logger.file.rotation_size_max" is changed.
  *
- * Returns:
+ * Return:
  *   1: value is OK
  *   0: value is invalid
  */
@@ -344,7 +343,7 @@ logger_config_level_create_option (const void *pointer, void *data,
 }
 
 /*
- * Gets a level option.
+ * Get a level option.
  */
 
 struct t_config_option *
@@ -356,7 +355,7 @@ logger_config_get_level (const char *name)
 }
 
 /*
- * Sets a level option.
+ * Set a level option.
  */
 
 int
@@ -471,7 +470,7 @@ logger_config_mask_create_option (const void *pointer, void *data,
 }
 
 /*
- * Gets a mask option.
+ * Get a mask option.
  */
 
 struct t_config_option *
@@ -483,9 +482,9 @@ logger_config_get_mask (const char *name)
 }
 
 /*
- * Initializes logger configuration file.
+ * Initialize logger configuration file.
  *
- * Returns:
+ * Return:
  *   1: OK
  *   0: error
  */
@@ -746,7 +745,7 @@ logger_config_init (void)
 }
 
 /*
- * Reads logger configuration file.
+ * Read logger configuration file.
  */
 
 int
@@ -764,7 +763,7 @@ logger_config_read (void)
 }
 
 /*
- * Writes logger configuration file.
+ * Write logger configuration file.
  */
 
 int
@@ -774,7 +773,7 @@ logger_config_write (void)
 }
 
 /*
- * Frees logger configuration.
+ * Free logger configuration.
  */
 
 void

src/plugins/logger/logger-info.c

@@ -31,7 +31,7 @@
 
 
 /*
- * Returns info "logger_log_file".
+ * Return info "logger_log_file".
  */
 
 char *
@@ -82,7 +82,7 @@ logger_info_log_file_cb (const void *pointer, void *data,
 }
 
 /*
- * Returns logger infolist "logger_buffer".
+ * Return logger infolist "logger_buffer".
  */
 
 struct t_infolist *
@@ -138,7 +138,7 @@ logger_info_infolist_logger_buffer_cb (const void *pointer, void *data,
 
 
 /*
- * Hooks infolist for logger plugin.
+ * Hook infolist for logger plugin.
  */
 
 void

src/plugins/logger/logger-tail.c

@@ -41,7 +41,7 @@
 
 
 /*
- * Searches for last EOL in a string.
+ * Search for last EOL in a string.
  */
 
 const char *
@@ -62,7 +62,7 @@ logger_tail_last_eol (const char *string_start, const char *string_ptr)
 }
 
 /*
- * Compares two lines in arraylist.
+ * Compare two lines in arraylist.
  */
 
 int
@@ -79,7 +79,7 @@ logger_tail_lines_cmp_cb (void *data,
 }
 
 /*
- * Frees a line in arraylist.
+ * Free a line in arraylist.
  */
 
 void
@@ -94,7 +94,7 @@ logger_tail_lines_free_cb (void *data, struct t_arraylist *arraylist,
 }
 
 /*
- * Returns last lines of a file.
+ * Return last lines of a file.
  *
  * Note: result must be freed after use.
  */

src/plugins/logger/logger.c

@@ -52,9 +52,9 @@ struct t_hook *logger_hook_print = NULL;
 
 
 /*
- * Checks conditions against a buffer.
+ * Check conditions against a buffer.
  *
- * Returns:
+ * Return:
  *   1: conditions OK
  *   0: conditions not OK
  */
@@ -105,7 +105,7 @@ logger_check_conditions (struct t_gui_buffer *buffer, const char *conditions)
 }
 
 /*
- * Gets logger file path option.
+ * Get logger file path option.
  *
  * Special vars are replaced:
  *   - with call to function string_eval_path_home
@@ -164,9 +164,9 @@ end:
 }
 
 /*
- * Creates logger directory.
+ * Create logger directory.
  *
- * Returns:
+ * Return:
  *   1: OK
  *   0: error
  */
@@ -201,7 +201,7 @@ logger_create_directory (void)
 }
 
 /*
- * Builds full name of buffer.
+ * Build full name of buffer.
  *
  * Note: result must be freed after use.
  */
@@ -224,9 +224,9 @@ logger_build_option_name (struct t_gui_buffer *buffer)
 }
 
 /*
- * Gets logging level for buffer.
+ * Get logging level for buffer.
  *
- * Returns level between 0 and 9 (0 = logging disabled).
+ * Return level between 0 and 9 (0 = logging disabled).
  */
 
 int
@@ -282,7 +282,7 @@ logger_get_level_for_buffer (struct t_gui_buffer *buffer)
 }
 
 /*
- * Gets filename mask for a buffer.
+ * Get filename mask for a buffer.
  *
  * First tries with all arguments, then removes one by one to find mask (from
  * specific to general mask).
@@ -340,7 +340,7 @@ logger_get_mask_for_buffer (struct t_gui_buffer *buffer)
 }
 
 /*
- * Gets expanded mask for a buffer.
+ * Get expanded mask for a buffer.
  *
  * Special vars are replaced:
  *   - local variables of buffer ($plugin, $name, ..)
@@ -443,7 +443,7 @@ end:
 }
 
 /*
- * Builds log filename for a buffer.
+ * Build log filename for a buffer.
  *
  * Note: result must be freed after use.
  */
@@ -627,7 +627,7 @@ logger_day_changed_signal_cb (const void *pointer, void *data,
 }
 
 /*
- * Gets info with tags of line: log level and if prefix is a nick.
+ * Get info with tags of line: log level and if prefix is a nick.
  */
 
 void
@@ -768,7 +768,7 @@ logger_timer_cb (const void *pointer, void *data, int remaining_calls)
 }
 
 /*
- * Initializes logger plugin.
+ * Initialize logger plugin.
  */
 
 int
@@ -812,7 +812,7 @@ weechat_plugin_init (struct t_weechat_plugin *plugin, int argc, char *argv[])
 }
 
 /*
- * Ends logger plugin.
+ * End logger plugin.
  */
 
 int