Skip to content

Commit

Permalink
SchemaManager: Make documentation more concise
Browse files Browse the repository at this point in the history
  • Loading branch information
xeruf committed Jul 9, 2020
1 parent db446ad commit 6105b0e
Showing 1 changed file with 2 additions and 5 deletions.
7 changes: 2 additions & 5 deletions src/database/schemamanager.h
Original file line number Diff line number Diff line change
Expand Up @@ -29,18 +29,15 @@ 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.
///
/// Returns true if the targetVersion is greater or equal to the
/// 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);
Expand Down

0 comments on commit 6105b0e

Please sign in to comment.