[Libreoffice-commits] online.git: loolwsd/ChildProcessSession.cpp loolwsd/LOOLKit.cpp loolwsd/LOOLSession.hpp loolwsd/LOOLWSD.hpp loolwsd/QueueHandler.hpp loolwsd/Rectangle.hpp loolwsd/Util.hpp

[Miklos Vajna]

 loolwsd/ChildProcessSession.cpp |    3 +--
 loolwsd/LOOLKit.cpp             |   14 +++++++-------
 loolwsd/LOOLSession.hpp         |    9 ++++-----
 loolwsd/LOOLWSD.hpp             |    4 ++--
 loolwsd/QueueHandler.hpp        |    3 +--
 loolwsd/Rectangle.hpp           |    1 +
 loolwsd/Util.hpp                |    7 +++----
 7 files changed, 19 insertions(+), 22 deletions(-)

New commits:
commit 4b3c5ea8ff690a1211354d8da1beaced952a58be
Author: Miklos Vajna <vmiklos at collabora.co.uk>
Date:   Thu Jan 28 19:16:32 2016 +0100

    loolwsd: doxygenize class comments

diff --git a/loolwsd/ChildProcessSession.cpp b/loolwsd/ChildProcessSession.cpp
index a21cf27..bc5f182 100644
--- a/loolwsd/ChildProcessSession.cpp
+++ b/loolwsd/ChildProcessSession.cpp
@@ -61,8 +61,7 @@ public:
     const std::string _aPayload;
 };
 
-// This thread handles callbacks from the
-// lokit instance.
+/// This thread handles callbacks from the lokit instance.
 class CallbackWorker: public Poco::Runnable
 {
 public:
diff --git a/loolwsd/LOOLKit.cpp b/loolwsd/LOOLKit.cpp
index 0c6f43f..40ee3de 100644
--- a/loolwsd/LOOLKit.cpp
+++ b/loolwsd/LOOLKit.cpp
@@ -207,13 +207,13 @@ private:
     volatile bool _stop;
 };
 
-// A document container.
-// Owns LOKitDocument instance and connections.
-// Manages the lifetime of a document.
-// Technically, we can host multiple documents
-// per process. But for security reasons don't.
-// However, we could have a loolkit instance
-// per user or group of users (a trusted circle).
+/// A document container.
+/// Owns LOKitDocument instance and connections.
+/// Manages the lifetime of a document.
+/// Technically, we can host multiple documents
+/// per process. But for security reasons don't.
+/// However, we could have a loolkit instance
+/// per user or group of users (a trusted circle).
 class Document
 {
 public:
diff --git a/loolwsd/LOOLSession.hpp b/loolwsd/LOOLSession.hpp
index 70aff29..62769e2 100644
--- a/loolwsd/LOOLSession.hpp
+++ b/loolwsd/LOOLSession.hpp
@@ -32,14 +32,13 @@
 #include "MessageQueue.hpp"
 #include "TileCache.hpp"
 
-// We have three kinds of Websocket sessions
-// 1) Between the master loolwsd server to the end-user LOOL client
-// 2) Between the master loolwsd server and a jailed loolwsd child process, in the master process
-// 3) Ditto, in the jailed loolwsd process
-
 class LOOLSession
 {
 public:
+    /// We have three kinds of Websocket sessions
+    /// 1) Between the master loolwsd server to the end-user LOOL client
+    /// 2) Between the master loolwsd server and a jailed loolwsd child process, in the master process
+    /// 3) Ditto, in the jailed loolwsd process
     enum class Kind { ToClient, ToPrisoner, ToMaster };
 
     const std::string& getId() const { return _id; }
diff --git a/loolwsd/LOOLWSD.hpp b/loolwsd/LOOLWSD.hpp
index 36bebb9..5c42a31 100644
--- a/loolwsd/LOOLWSD.hpp
+++ b/loolwsd/LOOLWSD.hpp
@@ -25,8 +25,8 @@
 #include "Common.hpp"
 #include "Util.hpp"
 
-// A DocumentURI as mananged by us.
-// Contains URI, physical path, etc.
+/// A DocumentURI as mananged by us.
+/// Contains URI, physical path, etc.
 class DocumentURI
 {
 public:
diff --git a/loolwsd/QueueHandler.hpp b/loolwsd/QueueHandler.hpp
index 97c70d8..9ac17a2 100644
--- a/loolwsd/QueueHandler.hpp
+++ b/loolwsd/QueueHandler.hpp
@@ -13,8 +13,7 @@
 #include "LOOLSession.hpp"
 #include "Util.hpp"
 
-// This thread handles incoming messages
-// on a given kit instance.
+/// This thread handles incoming messages on a given kit instance.
 class QueueHandler: public Poco::Runnable
 {
 public:
diff --git a/loolwsd/Rectangle.hpp b/loolwsd/Rectangle.hpp
index bac02b4..c6c6efc 100644
--- a/loolwsd/Rectangle.hpp
+++ b/loolwsd/Rectangle.hpp
@@ -15,6 +15,7 @@
 namespace Util
 {
 
+/// Holds the position and size of a rectangle.
 struct Rectangle
 {
     int _x1;
diff --git a/loolwsd/Util.hpp b/loolwsd/Util.hpp
index eff40bd..2f74c28 100644
--- a/loolwsd/Util.hpp
+++ b/loolwsd/Util.hpp
@@ -113,10 +113,9 @@ namespace Log
     void warn(const std::string& msg, const bool append_errno = false);
     void error(const std::string& msg, const bool append_errno = true);
 
-    // The following is to write streaming logs.
-    // Log::info() << "Value: 0x" << std::hex << value
-    //             << ", pointer: " << this << Log::end;
-
+    /// The following is to write streaming logs.
+    /// Log::info() << "Value: 0x" << std::hex << value
+    ///             << ", pointer: " << this << Log::end;
     static const struct _end_marker
     {
         _end_marker()