From: Camila Ayres <hello@camilasan.com>
Date: Wed, 6 Nov 2024 13:48:40 +0000 (+0100)
Subject: Add documentation about Utility::setupFavLink and Utility::removeFavLink.
X-Git-Tag: archive/raspbian/3.16.7-1_deb13u1+rpi1~1^2~12^2~5^2~52^2~1
X-Git-Url: https://dgit.raspbian.org/?a=commitdiff_plain;h=38eefd4dc7c6ed1f41d89a1d656e4a7722868ab1;p=nextcloud-desktop.git

Add documentation about Utility::setupFavLink and Utility::removeFavLink.

Signed-off-by: Camila Ayres <hello@camilasan.com>
---

diff --git a/src/common/utility.h b/src/common/utility.h
index 5f8794695..167eb6b8e 100644
--- 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();