From 506ff0e112d367e0cb931dd43c8e507375246302 Mon Sep 17 00:00:00 2001
From: shermp <14854761+shermp@users.noreply.github.com>
Date: Thu, 18 Apr 2024 19:14:28 +1200
Subject: [PATCH] Add fssync documentation

---
 src/ndb/NDBDbus.cc | 33 +++++++++++++++++++++++++++++++++
 1 file changed, 33 insertions(+)

diff --git a/src/ndb/NDBDbus.cc b/src/ndb/NDBDbus.cc
index 4163c0c..b9f63e9 100644
--- a/src/ndb/NDBDbus.cc
+++ b/src/ndb/NDBDbus.cc
@@ -716,16 +716,49 @@ void NDBDbus::pfmRescanBooksFull() {
     return ndbNickelMisc("rescan_books_full");
 }
 
+/*!
+ * \brief Begins a filesystem sync to add/remove content from onboard storage
+ * 
+ * This is a more targeted option to add new content compared to \a pfmRescanBooks 
+ * and \a pfmRescanBooksFull. It is what the browser uses when downloading
+ * ebook files.
+ * 
+ * Emits \a fssGotNumFilesToProcess signal to specify the number of files 
+ * to be added, \a fssParseProgress to specify the current progress, and the 
+ * \a fssFinished signal is emitted when complete.
+ */
 void NDBDbus::n3fssSyncOnboard() {
     QStringList path("/mnt/onboard");
     return n3fssSync(&path);
 }
 
+/*!
+ * \brief Begins a filesystem sync to add/remove content from sd storage
+ * 
+ * This is a more targeted option to add new content compared to \a pfmRescanBooks 
+ * and \a pfmRescanBooksFull. It is what the browser uses when downloading
+ * ebook files.
+ * 
+ * Emits \a fssGotNumFilesToProcess signal to specify the number of files 
+ * to be added, \a fssParseProgress to specify the current progress, and the 
+ * \a fssFinished signal is emitted when complete.
+ */
 void NDBDbus::n3fssSyncSD() {
     QStringList path("/mnt/sd");
     return n3fssSync(&path);
 }
 
+/*!
+ * \brief Begins a filesystem sync to add/remove content from onboard and sd storage
+ * 
+ * This is a more targeted option to add new content compared to \a pfmRescanBooks 
+ * and \a pfmRescanBooksFull. It is what the browser uses when downloading
+ * ebook files.
+ * 
+ * Emits \a fssGotNumFilesToProcess signal to specify the number of files 
+ * to be added, \a fssParseProgress to specify the current progress, and the 
+ * \a fssFinished signal is emitted when complete.
+ */
 void NDBDbus::n3fssSyncBoth() {
     QStringList paths = QStringList() << "/mnt/onboard" << "/mnt/sd";
     return n3fssSync(&paths);