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 5f87946952a9d0f1868f01c70fa8360d669cceb8..167eb6b8e668bcaaa6a21459bcaebc750415d0b9 100644 (file)
--- 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();