Add documentation about Utility::setupFavLink and Utility::removeFavL…

…ink. Signed-off-by: Camila Ayres <[email protected]>
nextcloud · Nov 6, 2024 · 9a88f10 · 9a88f10
1 parent 3e46764
commit 9a88f10
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/src/common/utility.h b/src/common/utility.h
@@ -66,8 +66,19 @@ namespace Utility {
     OCSYNC_EXPORT void sleep(int sec);
     OCSYNC_EXPORT void usleep(int usec);
     OCSYNC_EXPORT QString formatFingerprint(const QByteArray &, bool colonSeparated = true);
+    /**
+     * @brief Creates the Desktop.ini file which contains the folder IconResource shown as a favorite link
+     *
+     * @param folder absolute file path to folder
+     */
     OCSYNC_EXPORT void setupFavLink(const QString &folder);
+    /**
+     * @brief Removes the Desktop.ini file which contains the folder IconResource shown as a favorite link
+     *
+     * @param folder absolute file path to folder
+     */
     OCSYNC_EXPORT void removeFavLink(const QString &folder);
+
     OCSYNC_EXPORT bool writeRandomFile(const QString &fname, int size = -1);
     OCSYNC_EXPORT QString octetsToString(const qint64 octets);
     OCSYNC_EXPORT QByteArray userAgentString();