docs: collect duplicate func descriptions in .h

Author: benjaminbruun

include/onomondo/softsim/storage.h

@@ -41,11 +41,47 @@ int ss_storage_set_path(const char *path);
  *  \returns Pointer to the current storage path. */
 const char *ss_storage_get_path(void);
 
+/*! Get file definition for file (tip of the path).
+ *  \param[inout] path to the file for which the definition should be read.
+ *  \returns 0 on success, -EINVAL on failure */
 int ss_storage_get_file_def(struct ss_list *path);
+
+/*! Get content from file (tip of the path).
+ *  \param[in] path path to the file to be read.
+ *  \param[in] read_offset offset to start reading the file at.
+ *  \param[in] read_len length of data to read.
+ *  \returns buffer with content data on success, NULL on failure. */
 struct ss_buf *ss_storage_read_file(const struct ss_list *path, size_t read_offset, size_t read_len);
+
+/*! Get the total size in bytes of a file.
+ *  \param[in] path path to the file that gets selected.
+ *  \returns size in bytes on success, 0 on failure. */
 size_t ss_storage_get_file_len(const struct ss_list *path);
+
+/*! Write data to a file (tip of the path).
+ *  \param[in] path path to the file to be written.
+ *  \param[in] write_offset offset to start writing the file at.
+ *  \param[in] write_len length of data to be written.
+ *  \returns 0 on success, -EINVAL on failure. */
 int ss_storage_write_file(const struct ss_list *path, const uint8_t *data, size_t write_offset, size_t write_len);
+
+/*! Delete file or directory in the file system.
+ *  \param[in] path path to the file or directory to delete.
+ *  \returns 0 on success, -EINVAL on failure. */
 int ss_storage_delete(const struct ss_list *path);
+
+/*! Update definition file in the file system.
+ *  \param[in] path path to the file to update.
+ *  \returns 0 on success, -EINVAL on failure */
 int ss_storage_update_def(const struct ss_list *path);
+
+/*! Create a file in the file system.
+ *  \param[in] path path to the file that gets selected.
+ *  \param[in] file_len length of the file to create (filled with 0xff).
+ *  \returns 0 success, -EINVAL on failure */
 int ss_storage_create_file(const struct ss_list *path, size_t file_len);
+
+/*! Create a directory in the file system.
+ *  \param[in] path path to the directory to create.
+ *  \returns 0 on success, -EINVAL on failure */
 int ss_storage_create_dir(const struct ss_list *path);

src/softsim/storage.c

@@ -111,9 +111,6 @@ static int read_file_def(char *host_path, struct ss_file *file)
 	return 0;
 }
 
-/*! Get file definition for file (tip of the path).
- *  \param[inout] path to the file for which the definition should be read.
- *  \returns 0 on success, -EINVAL on failure */
 int ss_storage_get_file_def(struct ss_list *path)
 {
 	/*! Note: This function will allocate memory in file to store the file
@@ -134,11 +131,6 @@ int ss_storage_get_file_def(struct ss_list *path)
 	return read_file_def(host_path, file);
 }
 
-/*! Get content from file (tip of the path).
- *  \param[in] path path to the file to be read.
- *  \param[in] read_offset offset to start reading the file at.
- *  \param[in] read_len length of data to read.
- *  \returns buffer with content data on success, NULL on failure. */
 struct ss_buf *ss_storage_read_file(const struct ss_list *path, size_t read_offset, size_t read_len)
 {
 	/*! Note: This function will allocate memory in fileto store the file
@@ -196,11 +188,6 @@ struct ss_buf *ss_storage_read_file(const struct ss_list *path, size_t read_offs
 	return result;
 }
 
-/*! Write data to a file (tip of the path).
- *  \param[in] path path to the file to be written.
- *  \param[in] write_offset offset to start writing the file at.
- *  \param[in] write_len length of data to be written.
- *  \returns 0 on success, -EINVAL on failure. */
 int ss_storage_write_file(const struct ss_list *path, const uint8_t *data, size_t write_offset, size_t write_len)
 {
 	char host_path[SS_STORAGE_PATH_MAX + 1];
@@ -245,9 +232,6 @@ int ss_storage_write_file(const struct ss_list *path, const uint8_t *data, size_
 	return 0;
 }
 
-/*! Get the total size in bytes of a file.
- *  \param[in] path path to the file that gets selected.
- *  \returns size in bytes on success, 0 on failure. */
 size_t ss_storage_get_file_len(const struct ss_list *path)
 {
 	char host_path[SS_STORAGE_PATH_MAX + 1];
@@ -274,9 +258,6 @@ size_t ss_storage_get_file_len(const struct ss_list *path)
 	return file_size;
 }
 
-/*! Delete file or directory in the file system.
- *  \param[in] path path to the file or directory to delete.
- *  \returns 0 on success, -EINVAL on failure. */
 int ss_storage_delete(const struct ss_list *path)
 {
 	char host_path_def[SS_STORAGE_PATH_MAX + 1];
@@ -312,9 +293,6 @@ int ss_storage_delete(const struct ss_list *path)
 	return 0;
 }
 
-/*! Update definition file in the file system.
- *  \param[in] path path to the file to update.
- *  \returns 0 on success, -EINVAL on failure */
 int ss_storage_update_def(const struct ss_list *path)
 {
 	char host_path[SS_STORAGE_PATH_MAX + 1];
@@ -358,10 +336,6 @@ int ss_storage_update_def(const struct ss_list *path)
 	return 0;
 }
 
-/*! Create a file in the file system.
- *  \param[in] path path to the file that gets selected.
- *  \param[in] file_len length of the file to create (filled with 0xff).
- *  \returns 0 success, -EINVAL on failure */
 int ss_storage_create_file(const struct ss_list *path, size_t file_len)
 {
 	/*! Note: This function must not be called with pathes that point to
@@ -402,14 +376,9 @@ int ss_storage_create_file(const struct ss_list *path, size_t file_len)
 	return 0;
 }
 
-/*! Create a directory in the file system.
- *  \param[in] path path to the directory to create.
- *  \returns 0 on success, -EINVAL on failure */
 int ss_storage_create_dir(const struct ss_list *path)
 {
-	/*! Note: This function must not be called with pathes that point to
-	 *  a directory! */
-
+	/*! Note: This function must not be called with pathes that point to a directory! */
 	char host_path[SS_STORAGE_PATH_MAX + 1];
 	int rc;
 

src/softsim/storage_compact.c

@@ -106,9 +106,6 @@ static int read_file_def(char *host_path, struct ss_file *file)
 	return 0;
 }
 
-/*! Get file definition for a file (tip of the path).
- *  \param[inout] path to the file for which the definition should be read.
- *  \returns 0 on success, -EINVAL on failure */
 int ss_storage_get_file_def(struct ss_list *path)
 {
 	/*! Note: This function will allocate memory in file to store the file
@@ -130,11 +127,6 @@ int ss_storage_get_file_def(struct ss_list *path)
 	return read_file_def(host_path, file);
 }
 
-/*! Get content from a file (tip of the path).
- *  \param[in] path path to the file to be read.
- *  \param[in] read_offset offset to start reading the file at.
- *  \param[in] read_len length of data to read.
- *  \returns buffer with content data on success, NULL on failure. */
 struct ss_buf *ss_storage_read_file(const struct ss_list *path, size_t read_offset, size_t read_len)
 {
 	/*! Note: This function will allocate memory in file to store the file
@@ -189,11 +181,6 @@ struct ss_buf *ss_storage_read_file(const struct ss_list *path, size_t read_offs
 	return result;
 }
 
-/*! Write data to a file (tip of the path).
- *  \param[in] path path to the file to be written.
- *  \param[in] write_offset offset to start writing the file at.
- *  \param[in] write_len length of data to be written.
- *  \returns 0 on success, -EINVAL on failure. */
 int ss_storage_write_file(const struct ss_list *path, const uint8_t *data, size_t write_offset, size_t write_len)
 {
 	char host_path[SS_STORAGE_PATH_MAX + 1];
@@ -235,9 +222,6 @@ int ss_storage_write_file(const struct ss_list *path, const uint8_t *data, size_
 	return 0;
 }
 
-/*! Get the total size in bytes of a file.
- *  \param[in] path path to the file that gets selected.
- *  \returns size in bytes on success, 0 on failure. */
 size_t ss_storage_get_file_len(const struct ss_list *path)
 {
 	char host_path[SS_STORAGE_PATH_MAX + 1];
@@ -281,9 +265,6 @@ size_t ss_storage_get_file_len(const struct ss_list *path)
 	return file_size;
 }
 
-/*! Delete a file or directory in the file system.
- *  \param[in] path path to the file or directory to delete.
- *  \returns 0 on success, -EINVAL on failure. */
 int ss_storage_delete(const struct ss_list *path)
 {
 	char host_path_def[SS_STORAGE_PATH_MAX + 1];
@@ -321,9 +302,6 @@ int ss_storage_delete(const struct ss_list *path)
 	return 0;
 }
 
-/*! Update the definition file in the file system.
- *  \param[in] path path to the file to update.
- *  \returns 0 on success, -EINVAL on failure. */
 int ss_storage_update_def(const struct ss_list *path)
 {
 	char host_path[SS_STORAGE_PATH_MAX + 1];
@@ -366,10 +344,6 @@ int ss_storage_update_def(const struct ss_list *path)
 	return 0;
 }
 
-/*! Create a file in the file system.
- *  \param[in] path path to the file that gets selected.
- *  \param[in] file_len length of the file to create (filled with 0xff).
- *  \returns 0 on success, -EINVAL on failure. */
 int ss_storage_create_file(const struct ss_list *path, size_t file_len)
 {
 	/*! Note: This function must not be called with pathes that point to a directory! */
@@ -410,9 +384,6 @@ int ss_storage_create_file(const struct ss_list *path, size_t file_len)
 	return 0;
 }
 
-/*! Create a directory in the file system.
- *  \param[in] path path to the directory to create.
- *  \returns 0 on success, -EINVAL on failure. */
 int ss_storage_create_dir(const struct ss_list *path)
 {
 	/*! Note: This function must not be called with pathes that point to a directory! */