From 6105b0e5b4e5efedaf8415f495c1d81a67e46726 Mon Sep 17 00:00:00 2001 From: xerus2000 <27jf@pm.me> Date: Thu, 9 Jul 2020 13:36:18 +0200 Subject: [PATCH] SchemaManager: Make documentation more concise --- src/database/schemamanager.h | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/src/database/schemamanager.h b/src/database/schemamanager.h index 60144ae252b..9f4761ea7a3 100644 --- a/src/database/schemamanager.h +++ b/src/database/schemamanager.h @@ -29,8 +29,6 @@ class SchemaManager { return m_currentVersion; } - /// Check if the current version is backwards compatible with the given targetVersion. - /// /// If the current version has no backwards compatibility info, it is /// assumed that it is only compatible with itself. /// @@ -38,9 +36,8 @@ class SchemaManager { /// minimum compatible version of the current schema bool isBackwardsCompatibleWithVersion(int targetVersion) const; - /// Tries to upgrade the database schema to the given targetVersion. - /// First checks for version compatibility and whether the current version - /// already suffices the target and potentially aborts with the appropriate Result. + /// Does nothing if the versions are incompatible or the targetVersion is + /// older than the current one. Result upgradeToSchemaVersion( const QString& schemaFilename, int targetVersion);