utils: Move API doc from source to header

Signed-off-by: Alexander Dahl <[email protected]>
Urist-McGit · Sep 28, 2021 · 9c44b3e · 9c44b3e
1 parent 23a71f5
commit 9c44b3e
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/include/utils.h b/include/utils.h
@@ -132,13 +132,19 @@ G_GNUC_WARN_UNUSED_RESULT;
 gboolean check_remaining_keys(GKeyFile *key_file, const gchar *groupname, GError **error)
 G_GNUC_WARN_UNUSED_RESULT;
 
+/**
+ * Get string argument from key and remove key from key_file.
+ */
 gchar * key_file_consume_string(
 		GKeyFile *key_file,
 		const gchar *group_name,
 		const gchar *key,
 		GError **error)
 G_GNUC_WARN_UNUSED_RESULT;
 
+/**
+ * Get integer argument from key and remove key from key_file.
+ */
 gint key_file_consume_integer(
 		GKeyFile *key_file,
 		const gchar *group_name,

diff --git a/src/utils.c b/src/utils.c
@@ -183,7 +183,6 @@ gboolean check_remaining_keys(GKeyFile *key_file, const gchar *groupname, GError
 	return TRUE;
 }
 
-/* get string argument from key and remove key from key_file */
 gchar * key_file_consume_string(
 		GKeyFile *key_file,
 		const gchar *group_name,
@@ -211,7 +210,6 @@ gchar * key_file_consume_string(
 	return result;
 }
 
-/* get integer argument from key and remove key from key_file */
 gint key_file_consume_integer(
 		GKeyFile *key_file,
 		const gchar *group_name,