[prev in list] [next in list] [prev in thread] [next in thread] 

List:       kde-commits
Subject:    [kdevplatform/1.6] shell: Minor: Fix apidocs a bit
From:       Kevin Funk <kevin () kfunk ! org>
Date:       2014-02-04 17:11:38
Message-ID: E1WAjX8-0005WO-Bu () scm ! kde ! org
[Download RAW message or body]

Git commit 5466491a9248165dc43036418db0ebc7e62eb890 by Kevin Funk.
Committed on 04/02/2014 at 14:06.
Pushed by kfunk into branch '1.6'.

Minor: Fix apidocs a bit

M  +6    -3    shell/sessioncontroller.h

http://commits.kde.org/kdevplatform/5466491a9248165dc43036418db0ebc7e62eb890

diff --git a/shell/sessioncontroller.h b/shell/sessioncontroller.h
index 1986360..d7d8b82 100644
--- a/shell/sessioncontroller.h
+++ b/shell/sessioncontroller.h
@@ -126,9 +126,12 @@ public:
 
     static QList< SessionInfo > availableSessionInfo();
     
-    /// Shows a dialog where the user can choose the session
-    /// @param headerText an additional text that will be shown at the top in a label
-    /// @param onlyRunning whether only currently running sessions should be shown
+    /**
+     * Shows a dialog where the user can choose the session
+     * @param headerText an additional text that will be shown at the top in a label
+     * @param onlyRunning whether only currently running sessions should be shown
+     * @return UUID on success, empty string in any other case
+     */
     static QString showSessionChooserDialog(QString headerText = QString(), bool onlyRunning = false);
 
     /// Should be called if session to be opened is locked.
[prev in list] [next in list] [prev in thread] [next in thread]