Safemode: Add doxygen documentation

Change-Id: Ic5a7f5dfcefe66c961c9b71e9dbdfefeb9f06825

1 files changed, 20 insertions, 0 deletions

diff --git a/include/sfx2/safemode.hxx b/include/sfx2/safemode.hxx
index 666d2d4215ef..03f85904271c 100644
--- a/include/sfx2/safemode.hxx
+++ b/include/sfx2/safemode.hxx
@@ -19,9 +19,29 @@ namespace sfx2 {
 class SFX2_DLLPUBLIC SafeMode
 {
 public:
+    /**
+     * Write a flag file to the user profile indicating that the next launch should be in safe mode.
+     *
+     * @return Whether the file could be written successfully
+     */
     static bool putFlag();
+
+    /**
+     * Check the existence of the safe mode flag file.
+     *
+     * @return Whether the flag file for the safe mode exists
+     */
     static bool hasFlag();
+
+    /**
+     * Remove the flag file for the safe mode.
+     *
+     * @return Whether the flag file could be removed successfully
+     */
     static bool removeFlag();
+
+private:
+    /** Returns the path of the safe mode flag file.*/
     static OUString getFileName();
 };