ref: 69b1e688436895c51e2a8b0c936320378481bacd
parent: 53e241d0e5b3586f58f82d08874e1dec326280f4
author: gkostka <[email protected]>
date: Tue Dec 29 10:24:11 EST 2015
ext4: add doxygen doc for ext4_journal_start and ext4_journal_stop
--- a/lwext4/ext4.h
+++ b/lwext4/ext4.h
@@ -182,8 +182,24 @@
* @return standard error code */
int ext4_umount(const char *mount_point);
+/**@brief Start journaling. Journaling start/stop functions are transparent
+ * and might be used on filesystems without journaling support.
+ * @warning Usage:
+ * ext4_mount("sda1", "/");+ * ext4_journal_start("/");+ *
+ * //File operations here...
+ *
+ * ext4_journal_stop("/");+ * ext4_umount("/");+ * @param mount_point mount name
+ * @return standard error code */
int ext4_journal_start(const char *mount_point);
+/**@brief Stop journaling. Journaling start/stop functions are transparent
+ * and might be used on filesystems without journaling support.
+ * @param mount_point mount name
+ * @return standard error code */
int ext4_journal_stop(const char *mount_point);
/**@brief Journal recovery.