[Libreoffice-commits] online.git: 3 commits - loolwsd/ChildSession.hpp loolwsd/ClientSession.hpp loolwsd/LOOLSession.cpp loolwsd/LOOLSession.hpp loolwsd/PrisonerSession.hpp

[Tor Lillqvist]

 loolwsd/ChildSession.hpp    |    3 +--
 loolwsd/ClientSession.hpp   |    2 +-
 loolwsd/LOOLSession.cpp     |    1 -
 loolwsd/LOOLSession.hpp     |    2 +-
 loolwsd/PrisonerSession.hpp |    3 +--
 5 files changed, 4 insertions(+), 7 deletions(-)

New commits:
commit 9d03ff29460aeb4903d3684d0c1d4ba246c3ce94
Author: Tor Lillqvist <tml at collabora.com>
Date:   Fri Sep 16 10:00:03 2016 +0300

    No need to include ChildSession.hpp here

diff --git a/loolwsd/LOOLSession.cpp b/loolwsd/LOOLSession.cpp
index 3664bd0..055a489 100644
--- a/loolwsd/LOOLSession.cpp
+++ b/loolwsd/LOOLSession.cpp
@@ -33,7 +33,6 @@
 #include <Poco/StringTokenizer.h>
 #include <Poco/URI.h>
 
-#include "ChildSession.hpp"
 #include "Common.hpp"
 #include "IoUtil.hpp"
 #include "LOOLProtocol.hpp"
commit 4799bcc73ef325b4899fc47e6524e770fba84322
Author: Tor Lillqvist <tml at collabora.com>
Date:   Fri Sep 16 09:56:35 2016 +0300

    Clarify comments about the meaning of the three LOOLSession subclasses
    
    Be careful in using the definite article for classes that are
    instantiated as singletons in a process, and otherwise an indefinite
    article. Also mention in which process objects of the type in question
    exist.

diff --git a/loolwsd/ChildSession.hpp b/loolwsd/ChildSession.hpp
index f181ef9..e2b738c 100644
--- a/loolwsd/ChildSession.hpp
+++ b/loolwsd/ChildSession.hpp
@@ -49,8 +49,7 @@ public:
     void notifyCurrentViewOfOtherViews(const std::string& sessionId) const = 0;
 };
 
-/// Represents a client session, with the socket end-point,
-/// and handles all incoming UI traffic.
+/// Represents the session to the WSD process, in the Kit process.
 class ChildSession final : public LOOLSession
 {
 public:
diff --git a/loolwsd/ClientSession.hpp b/loolwsd/ClientSession.hpp
index dc531c8..f710088 100644
--- a/loolwsd/ClientSession.hpp
+++ b/loolwsd/ClientSession.hpp
@@ -16,7 +16,7 @@
 class DocumentBroker;
 class PrisonerSession;
 
-/// Represents client sessions and socket end-point in WSD.
+/// Represents a session to a LOOL client, in the WSD process.
 class ClientSession final : public LOOLSession, public std::enable_shared_from_this<ClientSession>
 {
 public:
diff --git a/loolwsd/PrisonerSession.hpp b/loolwsd/PrisonerSession.hpp
index 3ee088c..a40ce98 100644
--- a/loolwsd/PrisonerSession.hpp
+++ b/loolwsd/PrisonerSession.hpp
@@ -15,8 +15,7 @@
 class DocumentBroker;
 class ClientSession;
 
-/// An internal end-point in WSD with Kit process
-/// for a given client.
+/// Represents a session to a Kit process, in the WSD process.
 class PrisonerSession final : public LOOLSession, public std::enable_shared_from_this<PrisonerSession>
 {
 public:
commit 9d17637488799aeaef196fc96d650f6d7d2d4049
Author: Tor Lillqvist <tml at collabora.com>
Date:   Fri Sep 16 09:50:07 2016 +0300

    Fix comment

diff --git a/loolwsd/LOOLSession.hpp b/loolwsd/LOOLSession.hpp
index 0153339..4c7c485 100644
--- a/loolwsd/LOOLSession.hpp
+++ b/loolwsd/LOOLSession.hpp
@@ -28,7 +28,7 @@
 #include "TileCache.hpp"
 #include "Log.hpp"
 
-/// Base class of a client session.
+/// Base class of a WebSocket session.
 class LOOLSession
 {
 public: