Add documentation, clean up whitespace

Maintain tabs in .sql files, remove extra newline.

Add documentation to the setLastMsg function.

This helps maintain consistency with the other files.

diff --git a/src/core/SQL/PostgreSQL/20/setup_050_buffer.sql b/src/core/SQL/PostgreSQL/20/setup_050_buffer.sql
index a6665b5..a9206ac 100644 (file)
--- a/src/core/SQL/PostgreSQL/20/setup_050_buffer.sql
+++ b/src/core/SQL/PostgreSQL/20/setup_050_buffer.sql
@@ -6,7 +6,7 @@ create TABLE buffer (
        buffername varchar(128) NOT NULL,
        buffercname varchar(128) NOT NULL, -- CANONICAL BUFFER NAME (lowercase version)
        buffertype integer NOT NULL DEFAULT 0,
        buffername varchar(128) NOT NULL,
        buffercname varchar(128) NOT NULL, -- CANONICAL BUFFER NAME (lowercase version)
        buffertype integer NOT NULL DEFAULT 0,

-        lastmsgid integer NOT NULL DEFAULT 0,
+       lastmsgid integer NOT NULL DEFAULT 0,

        lastseenmsgid integer NOT NULL DEFAULT 0,
        markerlinemsgid integer NOT NULL DEFAULT 0,
        key varchar(128),
        lastseenmsgid integer NOT NULL DEFAULT 0,
        markerlinemsgid integer NOT NULL DEFAULT 0,
        key varchar(128),

diff --git a/src/core/SQL/SQLite/21/setup_030_buffer.sql b/src/core/SQL/SQLite/21/setup_030_buffer.sql
index 53ea542..952e20d 100644 (file)
--- a/src/core/SQL/SQLite/21/setup_030_buffer.sql
+++ b/src/core/SQL/SQLite/21/setup_030_buffer.sql
@@ -6,7 +6,7 @@ CREATE TABLE buffer (
        buffername TEXT NOT NULL,
        buffercname TEXT NOT NULL, -- CANONICAL BUFFER NAME (lowercase version)
        buffertype INTEGER NOT NULL DEFAULT 0,
        buffername TEXT NOT NULL,
        buffercname TEXT NOT NULL, -- CANONICAL BUFFER NAME (lowercase version)
        buffertype INTEGER NOT NULL DEFAULT 0,

-        lastmsgid INTEGER NOT NULL DEFAULT 0,
+       lastmsgid INTEGER NOT NULL DEFAULT 0,

        lastseenmsgid INTEGER NOT NULL DEFAULT 0,
        markerlinemsgid INTEGER NOT NULL DEFAULT 0,
        key TEXT,
        lastseenmsgid INTEGER NOT NULL DEFAULT 0,
        markerlinemsgid INTEGER NOT NULL DEFAULT 0,
        key TEXT,

diff --git a/src/core/SQL/SQLite/21/upgrade_006_alter_table_buffer_new_rename_to_buffer.sql b/src/core/SQL/SQLite/21/upgrade_006_alter_table_buffer_new_rename_to_buffer.sql
index cda4714..991f19c 100644 (file)
--- a/src/core/SQL/SQLite/21/upgrade_006_alter_table_buffer_new_rename_to_buffer.sql
+++ b/src/core/SQL/SQLite/21/upgrade_006_alter_table_buffer_new_rename_to_buffer.sql
@@ -1,2 +1 @@
 ALTER TABLE buffer_new RENAME TO buffer;
 ALTER TABLE buffer_new RENAME TO buffer;

-

diff --git a/src/core/postgresqlstorage.h b/src/core/postgresqlstorage.h
index 062aa0a..bffdb0d 100644 (file)
--- a/src/core/postgresqlstorage.h
+++ b/src/core/postgresqlstorage.h
@@ -95,6 +95,17 @@ public slots:
     virtual QHash<BufferId, MsgId> bufferLastSeenMsgIds(UserId user);
     virtual void setBufferMarkerLineMsg(UserId user, const BufferId &bufferId, const MsgId &msgId);
     virtual QHash<BufferId, MsgId> bufferMarkerLineMsgIds(UserId user);
     virtual QHash<BufferId, MsgId> bufferLastSeenMsgIds(UserId user);
     virtual void setBufferMarkerLineMsg(UserId user, const BufferId &bufferId, const MsgId &msgId);
     virtual QHash<BufferId, MsgId> bufferMarkerLineMsgIds(UserId user);

+    /**
+     * Sets the last known valid message ID for the given buffer.
+     *
+     * This limits LastSeenMsgIds from being set to message IDs in the future, improving performance
+     * when searching for messages in the backlog.
+     *
+     * @see PostgreSqlStorage::setBufferLastSeenMsg()
+     *
+     * @param bufferId[in] ID of the Buffer
+     * @param msgId[in]    ID of latest message for this buffer
+     */

     virtual void setBufferLastMsg(const BufferId &bufferId, const MsgId &msgId);
 
     /* Message handling */
     virtual void setBufferLastMsg(const BufferId &bufferId, const MsgId &msgId);
 
     /* Message handling */

diff --git a/src/core/sqlitestorage.h b/src/core/sqlitestorage.h
index f66e70f..e42feb4 100644 (file)
--- a/src/core/sqlitestorage.h
+++ b/src/core/sqlitestorage.h
@@ -96,6 +96,17 @@ public slots:
     virtual QHash<BufferId, MsgId> bufferLastSeenMsgIds(UserId user);
     virtual void setBufferMarkerLineMsg(UserId user, const BufferId &bufferId, const MsgId &msgId);
     virtual QHash<BufferId, MsgId> bufferMarkerLineMsgIds(UserId user);
     virtual QHash<BufferId, MsgId> bufferLastSeenMsgIds(UserId user);
     virtual void setBufferMarkerLineMsg(UserId user, const BufferId &bufferId, const MsgId &msgId);
     virtual QHash<BufferId, MsgId> bufferMarkerLineMsgIds(UserId user);

+    /**
+     * Sets the last known valid message ID for the given buffer.
+     *
+     * This limits LastSeenMsgIds from being set to message IDs in the future, improving performance
+     * when searching for messages in the backlog.
+     *
+     * @see SqliteStorage::setBufferLastSeenMsg()
+     *
+     * @param bufferId[in] ID of the Buffer
+     * @param msgId[in]    ID of latest message for this buffer
+     */

     virtual void setBufferLastMsg(const BufferId &bufferId, const MsgId &msgId);
 
     /* Message handling */
     virtual void setBufferLastMsg(const BufferId &bufferId, const MsgId &msgId);
 
     /* Message handling */