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

List:       kde-commits
Subject:    [kwayland] src/client: Improve grammar in api docs
From:       Sebastian_Kügler <sebas () kde ! org>
Date:       2014-09-30 22:25:41
Message-ID: E1XZ5rZ-0002Dv-Au () scm ! kde ! org
[Download RAW message or body]

Git commit 3a27ae0008c69d1961e6b907d4f5130ca0c2089d by Sebastian Kügler.
Committed on 30/09/2014 at 22:25.
Pushed by sebas into branch 'master'.

Improve grammar in api docs

M  +1    -1    src/client/output.h
M  +5    -5    src/client/shell.h

http://commits.kde.org/kwayland/3a27ae0008c69d1961e6b907d4f5130ca0c2089d

diff --git a/src/client/output.h b/src/client/output.h
index e8ebbda..fc2764b 100644
--- a/src/client/output.h
+++ b/src/client/output.h
@@ -39,7 +39,7 @@ namespace Client
  * @short Wrapper for the wl_output interface.
  *
  * This class provides a convenient wrapper for the wl_output interface.
- * It's main purpose is to hold the information about one Output.
+ * Its main purpose is to hold the information about one Output.
  *
  * To use this class one needs to interact with the Registry. There are two
  * possible ways to create an Output interface:
diff --git a/src/client/shell.h b/src/client/shell.h
index e865a49..2b6447d 100644
--- a/src/client/shell.h
+++ b/src/client/shell.h
@@ -84,9 +84,9 @@ public:
      **/
     void release();
     /**
-     * Destroys the data hold by this Shell.
+     * Destroys the data held by this Shell.
      * This method is supposed to be used when the connection to the Wayland
-     * server goes away. If the connection is not valid any more, it's not
+     * server goes away. Once the connection becomes invalid, it's not
      * possible to call release any more as that calls into the Wayland
      * connection and the call would fail. This method cleans up the data, so
      * that the instance can be deleted or setup to a new wl_shell interface
@@ -97,7 +97,7 @@ public:
      * connect(connection, &ConnectionThread::connectionDied, shell, &Shell::destroyed);
      * @endcode
      *
-     * Right before the data is destroyed the signal interfaceAboutToBeDestroyed is emitted.
+     * Right before the data is destroyed, the signal interfaceAboutToBeDestroyed is emitted.
      *
      * @see release
      * @see interfaceAboutToBeDestroyed
@@ -141,11 +141,11 @@ public:
 
 Q_SIGNALS:
     /**
-     * This signal is emitted right before the interface is going to be released.
+     * This signal is emitted right before the interface is released.
      **/
     void interfaceAboutToBeReleased();
     /**
-     * This signal is emitted right before the data is going to be destroyed.
+     * This signal is emitted right before the data is destroyed.
      **/
     void interfaceAboutToBeDestroyed();
 
[prev in list] [next in list] [prev in thread] [next in thread]