* Add start script for red hat compatible systems

Add descriptions for some rspamd API functions (no functional changes).

--HG--
rename : linux/rspamd => linux/rspamd_debian.in

1 files changed, 20 insertions, 0 deletions

diff --git a/src/message.h b/src/message.h
index d716f7906..5226b5209 100644
--- a/src/message.h
+++ b/src/message.h
@@ -64,8 +64,28 @@ struct raw_header {
  */
 gint process_message (struct worker_task *task);
 
+/*
+ * Set header with specified name and value
+ */
 void message_set_header (GMimeMessage *message, const gchar *field, const gchar *value);
+
+/*
+ * Get a list of header's values with specified header's name
+ * @param pool if not NULL this pool would be used for storing header's values
+ * @param message g_mime_message object
+ * @param field header's name
+ * @param strong if this flag is TRUE header's name is case sensitive, otherwise it is not
+ * @return A list of header's values or NULL. If list is not NULL it MUST be freed. If pool is NULL elements must be freed as well.
+ */
 GList* message_get_header (memory_pool_t *pool, GMimeMessage *message, const gchar *field, gboolean strong);
+
+/*
+ * Get a list of header's values with specified header's name using raw headers
+ * @param task worker task structure
+ * @param field header's name
+ * @param strong if this flag is TRUE header's name is case sensitive, otherwise it is not
+ * @return A list of header's values or NULL. Unlike previous function it is NOT required to free list or values. I should rework one of these functions some time.
+ */
 GList* message_get_raw_header (struct worker_task *task, const gchar *field, gboolean strong);
 
 #endif