From 4c8f6075d03f5d2983afc99ba2234aa67f483dda Mon Sep 17 00:00:00 2001 From: Simon Vetter Date: Tue, 14 May 2024 21:57:00 +0200 Subject: [PATCH] Fix documentation warnings --- .../comp_item_tables/comp_regions_table.h | 2 +- src/comp_tables/composite_column.cpp | 2 ++ src/comp_tables/composite_table.cpp | 6 ++--- src/comp_tables/fold_composite_column.cpp | 19 ++++++++------- src/comp_tables/numeric_fold_op.h | 2 +- src/data/item_id.cpp | 6 ++--- src/data/item_id.h | 2 +- src/data/trip.cpp | 4 ++-- src/db/associative_table.cpp | 16 ++++++------- src/db/column.cpp | 4 ++-- src/db/database.cpp | 1 + src/db/db_upgrade.cpp | 1 + src/db/row_index.cpp | 2 +- src/db/table.cpp | 2 +- src/db/table_buffer.cpp | 3 +-- src/db/tables_spec/ascents_table.cpp | 10 ++++---- src/db/tables_spec/countries_table.cpp | 23 +++++++++--------- src/db/tables_spec/hikers_table.cpp | 23 +++++++++--------- src/db/tables_spec/participated_table.cpp | 2 +- src/db/tables_spec/peaks_table.cpp | 23 +++++++++--------- src/db/tables_spec/photos_table.cpp | 24 +++++++++---------- src/db/tables_spec/ranges_table.cpp | 23 +++++++++--------- src/db/tables_spec/regions_table.cpp | 23 +++++++++--------- src/db/tables_spec/settings_table.cpp | 4 ++-- src/db/tables_spec/trips_table.cpp | 21 ++++++++-------- src/dialogs/ascent_dialog.cpp | 4 ---- src/dialogs/country_dialog.cpp | 3 --- src/dialogs/hiker_dialog.cpp | 3 --- src/dialogs/peak_dialog.cpp | 4 ---- src/dialogs/range_dialog.cpp | 3 --- src/dialogs/region_dialog.cpp | 3 --- src/dialogs/trip_dialog.cpp | 3 --- src/settings/project_settings.cpp | 18 +++++++------- src/settings/settings.h | 2 +- src/stats/chart.cpp | 2 +- src/stats/stats_engine.cpp | 2 -- src/stats/stats_listeners.h | 2 +- 37 files changed, 137 insertions(+), 160 deletions(-) diff --git a/src/comp_tables/comp_item_tables/comp_regions_table.h b/src/comp_tables/comp_item_tables/comp_regions_table.h index 5691c798..d5d14f7b 100644 --- a/src/comp_tables/comp_item_tables/comp_regions_table.h +++ b/src/comp_tables/comp_item_tables/comp_regions_table.h @@ -16,7 +16,7 @@ */ /** - * @file comp_regionss_table.h + * @file comp_regions_table.h * * This file defines the CompositeRegionsTable class. */ diff --git a/src/comp_tables/composite_column.cpp b/src/comp_tables/composite_column.cpp index 0204736c..07a24056 100644 --- a/src/comp_tables/composite_column.cpp +++ b/src/comp_tables/composite_column.cpp @@ -33,6 +33,7 @@ /** * Creates a CompositeColumn. * + * @param type The type of the composite column. * @param table The CompositeTable that this column belongs to. * @param name The internal name for this column. * @param uiName The name of this column as it should be displayed in the UI. @@ -726,6 +727,7 @@ QStringList DependentEnumCompositeColumn::encodeTypeSpecific() const * @param uiName The name of this column as it should be displayed in the UI. * @param suffix A suffix to append to the content of each cell. * @param sortingPasses The list of sorting passes in order of priority, each containing column and order. + * @param isOrdinal Whether or not this column is an OrdinalCompositeColumn. */ IndexCompositeColumn::IndexCompositeColumn(CompositeTable& table, QString name, QString uiName, QString suffix, const QList sortingPasses, bool isOrdinal) : CompositeColumn(isOrdinal ? Ordinal : Index, table, name, uiName, Integer, true, true, suffix), diff --git a/src/comp_tables/composite_table.cpp b/src/comp_tables/composite_table.cpp index 33a88a38..4d1bf173 100644 --- a/src/comp_tables/composite_table.cpp +++ b/src/comp_tables/composite_table.cpp @@ -96,7 +96,7 @@ void CompositeTable::reset() * * @pre No column with the same internal name has been added. * - * @param column The composite column to add. + * @param newColumn The composite column to add. */ void CompositeTable::addColumn(const CompositeColumn& newColumn) { @@ -112,7 +112,7 @@ void CompositeTable::addColumn(const CompositeColumn& newColumn) /** * Adds an export-only column to this table during initialization. * - * @param column The composite column to add as an export-only column. + * @param newColumn The composite column to add as an export-only column. */ void CompositeTable::addExportOnlyColumn(const CompositeColumn& newColumn) { @@ -130,7 +130,7 @@ void CompositeTable::addExportOnlyColumn(const CompositeColumn& newColumn) * * @pre No column with the same internal name has been added. * - * @param column The custom composite column to add. + * @param newColumn The custom composite column to add. */ void CompositeTable::addCustomColumn(const CompositeColumn& newColumn) { diff --git a/src/comp_tables/fold_composite_column.cpp b/src/comp_tables/fold_composite_column.cpp index 2ae360f8..13572c89 100644 --- a/src/comp_tables/fold_composite_column.cpp +++ b/src/comp_tables/fold_composite_column.cpp @@ -33,7 +33,8 @@ /** * Constructs a new FoldCompositeColumn. - * + * + * @param type The type of the composite column. * @param table The CompositeTable that this column belongs to. * @param name The internal name for this column. * @param uiName The name of this column as it should be displayed in the UI. @@ -41,6 +42,7 @@ * @param isStatistical Whether the contents of this column display statistical data which can be excluded from exports. * @param suffix A suffix to append to the content of each cell. * @param breadcrumbs A list of column pairs that lead from the base table's primary key column to the content column. + * @param contentColumn The single column which contains the values to fold, or null if not present. * @param enumNames An optional list of enum names with which to replace the raw cell content. */ FoldCompositeColumn::FoldCompositeColumn(CompColType type, CompositeTable& table, QString name, QString uiName, DataType contentType, bool isStatistical, QString suffix, const Breadcrumbs breadcrumbs, const ValueColumn* contentColumn, const QStringList* enumNames) : @@ -82,7 +84,7 @@ QSet FoldCompositeColumn::computeIDsAt(BufferRowIndex rowIndex) con /** * Returns a set of all columns in the base tables which are used to compute the content of * this column. - * + * * @return A set of all base table columns which are used to compute contents of this column. */ const QSet FoldCompositeColumn::getAllUnderlyingColumns() const @@ -140,7 +142,7 @@ CountFoldCompositeColumn* CountFoldCompositeColumn::decodeTypeSpecific(Composite /** * Constructs a new NumericFoldCompositeColumn. - * + * * @param table The CompositeTable that this column belongs to. * @param name The internal name for this column. * @param uiName The name of this column as it should be displayed in the UI. @@ -161,7 +163,7 @@ NumericFoldCompositeColumn::NumericFoldCompositeColumn(CompositeTable& table, QS * Computes the value of the cell at the given row index. * * Delegates breadcrumb evaluation to FoldCompositeColumn::evaluateBreadcrumbTrail(). - * + * * @param rowIndex The row index. * @return The computed value of the cell. */ @@ -245,12 +247,13 @@ NumericFoldCompositeColumn* NumericFoldCompositeColumn::decodeTypeSpecific(Compo /** * Constructs a new ListStringFoldCompositeColumn. - * + * * @param table The CompositeTable that this column belongs to. * @param name The internal name for this column. * @param uiName The name of this column as it should be displayed in the UI. * @param contentColumn The column whose values to list. * @param enumNames An optional list of enum names with which to replace the raw cell content. + * @param isHikerList Whether this is a HikerListFoldCompositeColumn. */ ListStringFoldCompositeColumn::ListStringFoldCompositeColumn(CompositeTable& table, QString name, QString uiName, const ValueColumn& contentColumn, const QStringList* enumNames, bool isHikerList) : FoldCompositeColumn(isHikerList ? HikerListFold : ListStringFold, table, name, uiName, String, false, QString(), table.crumbsTo((assert(!contentColumn.table.isAssociative), (NormalTable&) contentColumn.table)), &contentColumn, enumNames) @@ -263,7 +266,7 @@ ListStringFoldCompositeColumn::ListStringFoldCompositeColumn(CompositeTable& tab * * Delegates breadcrumb evaluation to FoldCompositeColumn::evaluateBreadcrumbTrail() and string * formatting and sorting to formatAndSortIntoStringList(). - * + * * @param rowIndex The row index. * @return The computed value of the cell. */ @@ -339,7 +342,7 @@ ListStringFoldCompositeColumn* ListStringFoldCompositeColumn::decodeTypeSpecific /** * Constructs a new HikerListCompositeColumn. - * + * * @param table The CompositeTable that this column belongs to. * @param name The internal name for this column. * @param uiName The name of this column as it should be displayed in the UI. @@ -358,7 +361,7 @@ HikerListFoldCompositeColumn::HikerListFoldCompositeColumn(CompositeTable& table * * Delegates breadcrumb evaluation to FoldCompositeColumn::evaluateBreadcrumbTrail() and string * formatting and sorting to formatAndSortIntoStringList(). - * + * * @param rowIndex The row index. * @return The computed value of the cell. */ diff --git a/src/comp_tables/numeric_fold_op.h b/src/comp_tables/numeric_fold_op.h index 87a28c15..908f5630 100644 --- a/src/comp_tables/numeric_fold_op.h +++ b/src/comp_tables/numeric_fold_op.h @@ -32,7 +32,7 @@ struct NumericFoldOpNames * Returns the name of the given fold operation or an empty string if the type is * invalid. * - * @param type The fold operation. + * @param foldOp The fold operation. */ inline static QString getName(const NumericFoldOp foldOp) { diff --git a/src/data/item_id.cpp b/src/data/item_id.cpp index e2d2a910..7a2cec42 100644 --- a/src/data/item_id.cpp +++ b/src/data/item_id.cpp @@ -16,7 +16,7 @@ */ /** - * @file ItemID.cpp + * @file item_id.cpp * * This file defines the ItemID class and its subclass ValidItemID. */ @@ -55,7 +55,7 @@ ItemID::ItemID() : valid(false), id(LOWEST_LEGAL_ID - 1) /** * Creates an ItemID from another ItemID. * - * @param id A reference to the ItemID to copy. + * @param other A reference to the ItemID to copy. */ ItemID::ItemID(const ItemID& other) : valid(other.valid), id(other.id) {} @@ -168,7 +168,7 @@ ValidItemID::ValidItemID(QVariant id) : ItemID(id) /** * Creates an ValidItemID from another ValidItemID. * - * @param id A reference to the ValidItemID to copy. + * @param other A reference to the ValidItemID to copy. */ ValidItemID::ValidItemID(const ValidItemID& other) : ValidItemID(other.asQVariant()) {} diff --git a/src/data/item_id.h b/src/data/item_id.h index 7e09ffa8..4405e3bb 100644 --- a/src/data/item_id.h +++ b/src/data/item_id.h @@ -16,7 +16,7 @@ */ /** - * @file ItemID.h + * @file item_id.h * * This file declares the ItemID class and its subclass ValidItemID, and defines * the ItemIDPrivilegedFunctionAccessor class and corresponding macros. diff --git a/src/data/trip.cpp b/src/data/trip.cpp index 443c458a..16d398d6 100644 --- a/src/data/trip.cpp +++ b/src/data/trip.cpp @@ -27,9 +27,9 @@ /** * Creates a new trip object with the given properties. - * + * * @param tripID The ID of the trip item, if it already has one. Invalid ItemID otherwise. - * @param title The name of the trip, if specified. Empty QString otherwise. + * @param name The name of the trip, if specified. Empty QString otherwise. * @param startDate The start date of the trip, if specified. Invalid QDate otherwise. * @param endDate The end date of the trip, if specified. Invalid QDate otherwise. * @param description The description of the trip, if specified. Empty QString otherwise. diff --git a/src/db/associative_table.cpp b/src/db/associative_table.cpp index fa1927f6..2ed73942 100644 --- a/src/db/associative_table.cpp +++ b/src/db/associative_table.cpp @@ -191,7 +191,7 @@ QSet AssociativeTable::getMatchingEntries(const PrimaryForeignKeyCo * Adds a row to the table from a list of columns and a corresponding list of data. * * Delegates to Table::addRow(). - * + * * @param parent The parent window. * @param columnDataPairs Pairs of columns and corresponding data to add. */ @@ -204,7 +204,7 @@ void AssociativeTable::addRow(QWidget& parent, const QList& colu * Removes a row from the table, specified by primary keys. * * Delegates to Table::removeRow(...). - * + * * @param parent The parent window. * @param primaryKeyColumns The primary key columns. * @param primaryKeys The primary keys of the row to remove, in the same order as the columns. @@ -218,10 +218,10 @@ void AssociativeTable::removeRow(QWidget& parent, const QList& pr * Removes all rows from the table where the given column has the given value. * * Delegates to Table::removeMatchingRows(...). - * - * @param parent The parent window. - * @param column The column to check. - * @param key The value to check for. + * + * @param parent The parent window. + * @param column The column to check. + * @param primaryKey The primary key to check for. */ void AssociativeTable::removeMatchingRows(QWidget& parent, const Column& column, ValidItemID primaryKey) { @@ -232,7 +232,7 @@ void AssociativeTable::removeMatchingRows(QWidget& parent, const Column& column, * Removes all rows from the table where the given column has one of the given values. * * Delegates to Table::removeMatchingRows(...). - * + * * @param parent The parent window. * @param column The column to check. * @param primaryKeys The values to check for. @@ -249,7 +249,7 @@ void AssociativeTable::removeMatchingRows(QWidget& parent, const Column& column, /** * For the QAbstractItemModel implementation, fetches the data for the given span of roles and * indices (in the form of a QModelRoleDataSpan). - * + * * The data is not returned, but written back to the given QModelRoleDataSpan. */ void AssociativeTable::multiData(const QModelIndex& index, QModelRoleDataSpan roleDataSpan) const diff --git a/src/db/column.cpp b/src/db/column.cpp index 345ee8ec..6385e439 100644 --- a/src/db/column.cpp +++ b/src/db/column.cpp @@ -130,8 +130,8 @@ int Column::getIndex() const /** * Returns the value stored in this column at the given row index. * - * @param rowIndex The row index of the value to return. - * @return The value stored in this column at the given row index. + * @param bufferRowIndex The row index of the value to return. + * @return The value stored in this column at the given row index. */ QVariant Column::getValueAt(BufferRowIndex bufferRowIndex) const { diff --git a/src/db/database.cpp b/src/db/database.cpp index 66afd614..7ea712cb 100644 --- a/src/db/database.cpp +++ b/src/db/database.cpp @@ -180,6 +180,7 @@ bool Database::openExisting(QWidget& parent, const QString& filepath) * Copies the current database file to a new filepath and opens a connection to the new file. * * @param parent The parent window. + * @param filepath The filepath for the new copy of the database file to create and open. * @return True if the save was successful and the new file is now opened, false otherwise. */ bool Database::saveAs(QWidget& parent, const QString& filepath) diff --git a/src/db/db_upgrade.cpp b/src/db/db_upgrade.cpp index eec3dc80..313899fc 100644 --- a/src/db/db_upgrade.cpp +++ b/src/db/db_upgrade.cpp @@ -270,6 +270,7 @@ bool DatabaseUpgrader::showOutdatedAppWarningAndBackup(const QString& dbVersion) * fails. * * @param confirmationQuestion Translated string to insert into the message, asking the user whether to continue if the backup failed. + * @param currentDbVersion A string with the database's current (old) version. * @return True if the backup was created successfully or the user wants to continue anyway, false otherwise. */ bool DatabaseUpgrader::createFileBackupCopy(const QString& confirmationQuestion, const QString& currentDbVersion) diff --git a/src/db/row_index.cpp b/src/db/row_index.cpp index 6b2d3747..c1b540ee 100644 --- a/src/db/row_index.cpp +++ b/src/db/row_index.cpp @@ -237,7 +237,7 @@ void RowIndex::operator--(int) * This implementation is required for using RowIndex in QSets and implicitly comparing instances * of QList. * - * @param key The index to hash. + * @param index The index to hash. * @param seed The seed to use for hashing. * @return The hash value. */ diff --git a/src/db/table.cpp b/src/db/table.cpp index 7ba9d218..64d98acc 100644 --- a/src/db/table.cpp +++ b/src/db/table.cpp @@ -60,7 +60,7 @@ Table::~Table() /** * Adds a column to the table during initialization. * - * @param column The column to add. The table takes ownership of the column. + * @param newColumn The column to add. The table takes ownership of the column. */ void Table::addColumn(const Column& newColumn) { diff --git a/src/db/table_buffer.cpp b/src/db/table_buffer.cpp index fcfe6513..ab8a2c53 100644 --- a/src/db/table_buffer.cpp +++ b/src/db/table_buffer.cpp @@ -309,8 +309,7 @@ void ViewOrderBuffer::append(BufferRowIndex rowIndex) /** * Inserts the given buffer row index into the order buffer at the given view row index. * - * @param viewRowIndex The view row index at which to insert the given buffer row index. - * @param rowIndex The buffer row index to insert. + * @param viewRowIndex The view row index at which to remove the buffer row index. */ void ViewOrderBuffer::removeViewRow(ViewRowIndex viewRowIndex) { diff --git a/src/db/tables_spec/ascents_table.cpp b/src/db/tables_spec/ascents_table.cpp index b071f574..2be18973 100644 --- a/src/db/tables_spec/ascents_table.cpp +++ b/src/db/tables_spec/ascents_table.cpp @@ -157,7 +157,7 @@ const QList AscentsTable::mapDataToColumnDataPairs(const QList AscentsTable::getIdentityRepresentationColumns() const @@ -206,7 +206,7 @@ QString AscentsTable::getItemNameSingular() const /** * Returns the translated string to be displayed to indicate that no ascent is selected. - * + * * @return The translated string representing absence of an ascent. */ QString AscentsTable::getNoneString() const @@ -226,7 +226,7 @@ QString AscentsTable::getCreationConfirmMessage() const /** * Returns a translated message confirming that a number of ascents have been edited. - * + * * @param numEdited The number of ascents that have been edited. * @return The translated message confirming the editing of the ascents. */ @@ -237,7 +237,7 @@ QString AscentsTable::getEditConfirmMessage(int numEdited) const /** * Returns a translated message confirming that a number of ascents have been deleted. - * + * * @param numDeleted The number of ascents that have been deleted. * @return The translated message confirming the deletion of the ascents. */ diff --git a/src/db/tables_spec/countries_table.cpp b/src/db/tables_spec/countries_table.cpp index 9f5c1d3f..a2abd628 100644 --- a/src/db/tables_spec/countries_table.cpp +++ b/src/db/tables_spec/countries_table.cpp @@ -45,7 +45,7 @@ CountriesTable::CountriesTable(Database& db) : /** * Adds a new country to the table. - * + * * @param parent The parent widget. * @param country The country to add. * @return The index of the new country in the table buffer. @@ -62,11 +62,10 @@ BufferRowIndex CountriesTable::addRow(QWidget& parent, Country& country) /** * Updates the contents of an existing country in the table. - * - * @pre The given country's ItemID will be used to identify the country to update and thus must be valid. - * + * * @param parent The parent widget. - * @param country The country to update. + * @param countryID The ID of the country to update. + * @param country The country data to write to the row with the given ID. */ void CountriesTable::updateRow(QWidget& parent, ValidItemID countryID, const Country& country) { @@ -95,7 +94,7 @@ void CountriesTable::updateRows(QWidget& parent, const QSet& row /** * Translates the data of a country to a list of column-data pairs. - * + * * @param columns The column list specifying the order of the data. * @param country The country from which to get the data. * @return A list of column-data pairs representing the country's data. @@ -119,7 +118,7 @@ const QList CountriesTable::mapDataToColumnDataPairs(const QList /** * Returns a string representation of the country at the given buffer row index. - * + * * @param bufferRow The buffer row index of the country to represent. * @return A UI-appropriate string representation of the country. */ @@ -130,7 +129,7 @@ QString CountriesTable::getIdentityRepresentationAt(const BufferRowIndex& buffer /** * Returns a list of all columns used for identity representation of countries. - * + * * @return A list of all columns used for identity representation. */ QList CountriesTable::getIdentityRepresentationColumns() const @@ -142,7 +141,7 @@ QList CountriesTable::getIdentityRepresentationColumns() const /** * Returns the translation of "Country" (singular). - * + * * @return The translation of "Country" (singular). */ QString CountriesTable::getItemNameSingular() const @@ -152,7 +151,7 @@ QString CountriesTable::getItemNameSingular() const /** * Returns the translated string to be displayed to indicate that no country is selected. - * + * * @return The translated string representing absence of a country. */ QString CountriesTable::getNoneString() const @@ -172,7 +171,7 @@ QString CountriesTable::getCreationConfirmMessage() const /** * Returns a translated message confirming that a number of countries have been edited. - * + * * @param numEdited The number of countries that have been edited. * @return The translated message confirming the editing of the countries. */ @@ -183,7 +182,7 @@ QString CountriesTable::getEditConfirmMessage(int numEdited) const /** * Returns a translated message confirming that a number of countries have been deleted. - * + * * @param numDeleted The number of countries that have been deleted. * @return The translated message confirming the deletion of the countries. */ diff --git a/src/db/tables_spec/hikers_table.cpp b/src/db/tables_spec/hikers_table.cpp index b587d1f7..da15357b 100644 --- a/src/db/tables_spec/hikers_table.cpp +++ b/src/db/tables_spec/hikers_table.cpp @@ -45,7 +45,7 @@ HikersTable::HikersTable(Database& db) : /** * Adds a new hiker to the table. - * + * * @param parent The parent widget. * @param hiker The hiker to add. * @return The index of the new hiker in the table buffer. @@ -62,11 +62,10 @@ BufferRowIndex HikersTable::addRow(QWidget& parent, Hiker& hiker) /** * Updates the contents of an existing hiker in the table. - * - * @pre The given hiker's ItemID will be used to identify the hiker to update and thus must be valid. - * + * * @param parent The parent widget. - * @param hiker The hiker to update. + * @param hikerID The ID of the hiker to update. + * @param hiker The hiker data to write to the row with the given ID. */ void HikersTable::updateRow(QWidget& parent, ValidItemID hikerID, const Hiker& hiker) { @@ -95,7 +94,7 @@ void HikersTable::updateRows(QWidget& parent, const QSet& rowInd /** * Translates the data of a hiker to a list of column-data pairs. - * + * * @param columns The column list specifying the order of the data. * @param hiker The hiker from which to get the data. * @return A list of column-data pairs representing the hiker's data. @@ -119,7 +118,7 @@ const QList HikersTable::mapDataToColumnDataPairs(const QList HikersTable::getIdentityRepresentationColumns() const @@ -142,7 +141,7 @@ QList HikersTable::getIdentityRepresentationColumns() const /** * Returns the translation of "Hiker" (singular). - * + * * @return The translation of "Hiker" (singular). */ QString HikersTable::getItemNameSingular() const @@ -152,7 +151,7 @@ QString HikersTable::getItemNameSingular() const /** * Returns the translated string to be displayed to indicate that no hiker is selected. - * + * * @return The translated string representing absence of a hiker. */ QString HikersTable::getNoneString() const @@ -172,7 +171,7 @@ QString HikersTable::getCreationConfirmMessage() const /** * Returns a translated message confirming that a number of hikers have been edited. - * + * * @param numEdited The number of hikers that have been edited. * @return The translated message confirming the editing of the hikers. */ @@ -183,7 +182,7 @@ QString HikersTable::getEditConfirmMessage(int numEdited) const /** * Returns a translated message confirming that a number of hikers have been deleted. - * + * * @param numDeleted The number of hikers that have been deleted. * @return The translated message confirming the deletion of the hikers. */ diff --git a/src/db/tables_spec/participated_table.cpp b/src/db/tables_spec/participated_table.cpp index bf3a5146..c9d6466e 100644 --- a/src/db/tables_spec/participated_table.cpp +++ b/src/db/tables_spec/participated_table.cpp @@ -103,7 +103,7 @@ void ParticipatedTable::updateRows(QWidget& parent, const QSet& asc /** * Translates the data of a single participation to a list of column-data pairs. - * + * * @param columns The column list specifying the order of the data. * @param ascentID The ascentID of the participation. * @param hikerID The hikerID of the participation. diff --git a/src/db/tables_spec/peaks_table.cpp b/src/db/tables_spec/peaks_table.cpp index 28fcc97d..f08fc3dd 100644 --- a/src/db/tables_spec/peaks_table.cpp +++ b/src/db/tables_spec/peaks_table.cpp @@ -58,7 +58,7 @@ PeaksTable::PeaksTable(Database& db, PrimaryKeyColumn& foreignRegionIDColumn) : /** * Adds a new peak to the table. - * + * * @param parent The parent widget. * @param peak The peak to add. * @return The index of the new peak in the table buffer. @@ -75,11 +75,10 @@ BufferRowIndex PeaksTable::addRow(QWidget& parent, Peak& peak) /** * Updates the contents of an existing peak in the table. - * - * @pre The given peak's ItemID will be used to identify the peak to update and thus must be valid. - * + * * @param parent The parent widget. - * @param peak The peak to update. + * @param peakID The ID of the peak to update. + * @param peak The peak data to write to the row with the given ID. */ void PeaksTable::updateRow(QWidget& parent, ValidItemID peakID, const Peak& peak) { @@ -108,7 +107,7 @@ void PeaksTable::updateRows(QWidget& parent, const QSet& rowIndi /** * Translates the data of a peak to a list of column-data pairs. - * + * * @param columns The column list specifying the order of the data. * @param peak The peak from which to get the data. * @return A list of column-data pairs representing the peak's data. @@ -138,7 +137,7 @@ const QList PeaksTable::mapDataToColumnDataPairs(const QList PeaksTable::getIdentityRepresentationColumns() const @@ -161,7 +160,7 @@ QList PeaksTable::getIdentityRepresentationColumns() const /** * Returns the translation of "Peak" (singular). - * + * * @return The translation of "Peak" (singular). */ QString PeaksTable::getItemNameSingular() const @@ -171,7 +170,7 @@ QString PeaksTable::getItemNameSingular() const /** * Returns the translated string to be displayed to indicate that no peak is selected. - * + * * @return The translated string representing absence of a peak. */ QString PeaksTable::getNoneString() const @@ -191,7 +190,7 @@ QString PeaksTable::getCreationConfirmMessage() const /** * Returns a translated message confirming that a number of peaks have been edited. - * + * * @param numEdited The number of peaks that have been edited. * @return The translated message confirming the editing of the peaks. */ @@ -202,7 +201,7 @@ QString PeaksTable::getEditConfirmMessage(int numEdited) const /** * Returns a translated message confirming that a number of peaks have been deleted. - * + * * @param numDeleted The number of peaks that have been deleted. * @return The translated message confirming the deletion of the peaks. */ diff --git a/src/db/tables_spec/photos_table.cpp b/src/db/tables_spec/photos_table.cpp index 4fadb77d..3f846027 100644 --- a/src/db/tables_spec/photos_table.cpp +++ b/src/db/tables_spec/photos_table.cpp @@ -79,7 +79,7 @@ QList PhotosTable::getPhotosForAscent(ValidItemID ascentID) const /** * Adds one or more rows to the table, using a given ascentID and a list of photos. - * + * * @param parent The parent widget. * @param ascentID The ascentID to use for all rows. * @param photos The photos to add. @@ -96,7 +96,7 @@ void PhotosTable::addRows(QWidget& parent, ValidItemID ascentID, const QList PhotosTable::mapDataToColumnDataPairs(const QList PhotosTable::getIdentityRepresentationColumns() const @@ -242,7 +242,7 @@ QList PhotosTable::getIdentityRepresentationColumns() const /** * Returns the translation of "Photo" (singular). - * + * * @return The translation of "Photo" (singular). */ QString PhotosTable::getItemNameSingular() const @@ -252,7 +252,7 @@ QString PhotosTable::getItemNameSingular() const /** * Returns the translated string to be displayed to indicate that no photo is selected. - * + * * @return The translated string representing absence of a photo. */ QString PhotosTable::getNoneString() const @@ -272,7 +272,7 @@ QString PhotosTable::getCreationConfirmMessage() const /** * Returns a translated message confirming that a number of photos have been edited. - * + * * @param numEdited The number of photos that have been edited. * @return The translated message confirming the editing of the photos. */ @@ -283,7 +283,7 @@ QString PhotosTable::getEditConfirmMessage(int numEdited) const /** * Returns a translated message confirming that a number of photos have been deleted. - * + * * @param numDeleted The number of photos that have been deleted. * @return The translated message confirming the deletion of the photos. */ diff --git a/src/db/tables_spec/ranges_table.cpp b/src/db/tables_spec/ranges_table.cpp index 529faf22..d1879c33 100644 --- a/src/db/tables_spec/ranges_table.cpp +++ b/src/db/tables_spec/ranges_table.cpp @@ -49,7 +49,7 @@ RangesTable::RangesTable(Database& db) : /** * Adds a new range to the table. - * + * * @param parent The parent widget. * @param range The range to add. * @return The index of the new range in the table buffer. @@ -66,11 +66,10 @@ BufferRowIndex RangesTable::addRow(QWidget& parent, Range& range) /** * Updates the contents of an existing range in the table. - * - * @pre The given range's ItemID will be used to identify the range to update and thus must be valid. - * + * * @param parent The parent widget. - * @param range The range to update. + * @param rangeID The ID of the range to update. + * @param range The range data to write to the row with the given ID. */ void RangesTable::updateRow(QWidget& parent, ValidItemID rangeID, const Range& range) { @@ -99,7 +98,7 @@ void RangesTable::updateRows(QWidget& parent, const QSet& rowInd /** * Translates the data of a range to a list of column-data pairs. - * + * * @param columns The column list specifying the order of the data. * @param range The range from which to get the data. * @return A list of column-data pairs representing the range's data. @@ -124,7 +123,7 @@ const QList RangesTable::mapDataToColumnDataPairs(const QList RangesTable::getIdentityRepresentationColumns() const @@ -147,7 +146,7 @@ QList RangesTable::getIdentityRepresentationColumns() const /** * Returns the translation of "Mountain range" (singular). - * + * * @return The translation of "Mountain range" (singular). */ QString RangesTable::getItemNameSingular() const @@ -157,7 +156,7 @@ QString RangesTable::getItemNameSingular() const /** * Returns the translated string to be displayed to indicate that no range is selected. - * + * * @return The translated string representing absence of a mountain range. */ QString RangesTable::getNoneString() const @@ -177,7 +176,7 @@ QString RangesTable::getCreationConfirmMessage() const /** * Returns a translated message confirming that a number of mountain ranges have been edited. - * + * * @param numEdited The number of mountain ranges that have been edited. * @return The translated message confirming the editing of the mountain ranges. */ @@ -188,7 +187,7 @@ QString RangesTable::getEditConfirmMessage(int numEdited) const /** * Returns a translated message confirming that a number of mountain ranges have been deleted. - * + * * @param numDeleted The number of mountain ranges that have been deleted. * @return The translated message confirming the deletion of the mountain ranges. */ diff --git a/src/db/tables_spec/regions_table.cpp b/src/db/tables_spec/regions_table.cpp index 9f0eafbf..211a0baf 100644 --- a/src/db/tables_spec/regions_table.cpp +++ b/src/db/tables_spec/regions_table.cpp @@ -51,7 +51,7 @@ RegionsTable::RegionsTable(Database& db, PrimaryKeyColumn& foreignRangeIDColumn, /** * Adds a new region to the table. - * + * * @param parent The parent widget. * @param region The region to add. * @return The index of the new region in the table buffer. @@ -68,11 +68,10 @@ BufferRowIndex RegionsTable::addRow(QWidget& parent, Region& region) /** * Updates the contents of an existing region in the table. - * - * @pre The given region's ItemID will be used to identify the region to update and thus must be valid. - * + * * @param parent The parent widget. - * @param region The region to update. + * @param regionID The ID of the region to update. + * @param region The region data to write to the row with the given ID. */ void RegionsTable::updateRow(QWidget& parent, ValidItemID regionID, const Region& region) { @@ -101,7 +100,7 @@ void RegionsTable::updateRows(QWidget& parent, const QSet& rowIn /** * Translates the data of a region to a list of column-data pairs. - * + * * @param columns The column list specifying the order of the data. * @param region The region from which to get the data. * @return A list of column-data pairs representing the region's data. @@ -127,7 +126,7 @@ const QList RegionsTable::mapDataToColumnDataPairs(const QList RegionsTable::getIdentityRepresentationColumns() const @@ -150,7 +149,7 @@ QList RegionsTable::getIdentityRepresentationColumns() const /** * Returns the translation of "Region" (singular). - * + * * @return The translation of "Region" (singular). */ QString RegionsTable::getItemNameSingular() const @@ -160,7 +159,7 @@ QString RegionsTable::getItemNameSingular() const /** * Returns the translated string to be displayed to indicate that no region is selected. - * + * * @return The translated string representing absence of a region. */ QString RegionsTable::getNoneString() const @@ -180,7 +179,7 @@ QString RegionsTable::getCreationConfirmMessage() const /** * Returns a translated message confirming that a number of regions have been edited. - * + * * @param numEdited The number of regions that have been edited. * @return The translated message confirming the editing of the regions. */ @@ -191,7 +190,7 @@ QString RegionsTable::getEditConfirmMessage(int numEdited) const /** * Returns a translated message confirming that a number of regions have been deleted. - * + * * @param numDeleted The number of regions that have been deleted. * @return The translated message confirming the deletion of the regions. */ diff --git a/src/db/tables_spec/settings_table.cpp b/src/db/tables_spec/settings_table.cpp index bb2784b2..74f39175 100644 --- a/src/db/tables_spec/settings_table.cpp +++ b/src/db/tables_spec/settings_table.cpp @@ -139,7 +139,7 @@ void SettingsTable::clearSetting(QWidget& parent, const GenericProjectSetting& s /** * Removes the setting from the project settings table entirely. - * + * * @param parent The parent window. Cannot be nullptr. * @param setting The setting to remove. */ @@ -159,7 +159,7 @@ void SettingsTable::removeSetting(QWidget& parent, const GenericProjectSetting& * table. * * @param parent The parent window. Cannot be nullptr. - * @param setting The setting to remove. + * @param baseKey The common key of all settings to remove. */ void SettingsTable::removeAllMatchingSettings(QWidget& parent, const QString& baseKey) { diff --git a/src/db/tables_spec/trips_table.cpp b/src/db/tables_spec/trips_table.cpp index b3303228..945f7f66 100644 --- a/src/db/tables_spec/trips_table.cpp +++ b/src/db/tables_spec/trips_table.cpp @@ -68,11 +68,10 @@ BufferRowIndex TripsTable::addRow(QWidget& parent, Trip& trip) /** * Updates the contents of an existing trip in the table. - * - * @pre The given trip's ItemID will be used to identify the trip to update and thus must be valid. - * + * * @param parent The parent widget. - * @param trip The trip to update. + * @param tripID The ID of the region to update. + * @param trip The region data to write to the row with the given ID. */ void TripsTable::updateRow(QWidget& parent, ValidItemID tripID, const Trip& trip) { @@ -101,7 +100,7 @@ void TripsTable::updateRows(QWidget& parent, const QSet& rowIndi /** * Translates the data of a trip to a list of column-data pairs. - * + * * @param columns The column list specifying the order of the data. * @param trip The trip from which to get the data. * @return A list of column-data pairs representing the trip's data. @@ -128,7 +127,7 @@ const QList TripsTable::mapDataToColumnDataPairs(const QList TripsTable::getIdentityRepresentationColumns() const @@ -157,7 +156,7 @@ QList TripsTable::getIdentityRepresentationColumns() const /** * Returns the translation of "Trip" (singular). - * + * * @return The translation of "Trip" (singular). */ QString TripsTable::getItemNameSingular() const @@ -167,7 +166,7 @@ QString TripsTable::getItemNameSingular() const /** * Returns the translated string to be displayed to indicate that no trip is selected. - * + * * @return The translated string representing absence of a trip. */ QString TripsTable::getNoneString() const @@ -187,7 +186,7 @@ QString TripsTable::getCreationConfirmMessage() const /** * Returns a translated message confirming that a number of trips have been edited. - * + * * @param numEdited The number of trips that have been edited. * @return The translated message confirming the editing of the trips. */ @@ -198,7 +197,7 @@ QString TripsTable::getEditConfirmMessage(int numEdited) const /** * Returns a translated message confirming that a number of trips have been deleted. - * + * * @param numDeleted The number of items that have been deleted. * @return The translated message confirming the deletion of the trips. */ diff --git a/src/dialogs/ascent_dialog.cpp b/src/dialogs/ascent_dialog.cpp index e5a61fa9..7b4424d4 100644 --- a/src/dialogs/ascent_dialog.cpp +++ b/src/dialogs/ascent_dialog.cpp @@ -600,7 +600,6 @@ void AscentDialog::savePhotoDescriptionToList(const QItemSelection& selected, co * @param mainWindow The application's main window. * @param db The project database. * @param callWhenDone The function to call after the dialog has closed. - * @return The index of the new ascent in the database's ascent table buffer. */ void openNewAscentDialogAndStore(QWidget& parent, QMainWindow& mainWindow, Database& db, std::function callWhenDone) { @@ -635,7 +634,6 @@ void openNewAscentDialogAndStore(QWidget& parent, QMainWindow& mainWindow, Datab * @param db The project database. * @param bufferRowIndex The index of the ascent to duplicate in the database's ascent table buffer. * @param callWhenDone The function to call after the dialog has closed. - * @return The index of the new ascent in the database's ascent table buffer. */ void openDuplicateAscentDialogAndStore(QWidget& parent, QMainWindow& mainWindow, Database& db, BufferRowIndex bufferRowIndex, std::function callWhenDone) { @@ -673,7 +671,6 @@ void openDuplicateAscentDialogAndStore(QWidget& parent, QMainWindow& mainWindow, * @param db The project database. * @param bufferRowIndex The index of the ascent to edit in the database's ascent table buffer. * @param callWhenDone The function to call after the dialog has closed. - * @return True if any changes were made, false otherwise. */ void openEditAscentDialogAndStore(QWidget& parent, QMainWindow& mainWindow, Database& db, BufferRowIndex bufferRowIndex, std::function callWhenDone) { @@ -722,7 +719,6 @@ void openEditAscentDialogAndStore(QWidget& parent, QMainWindow& mainWindow, Data * @param bufferRowIndices The buffer row indices of the ascents to edit. * @param initBufferRowIndex The index of the ascent whose data to initialize the dialog with. * @param callWhenDone The function to call after the dialog has closed. - * @return True if any changes were made, false otherwise. */ void openMultiEditAscentsDialogAndStore(QWidget& parent, QMainWindow& mainWindow, Database& db, const QSet& bufferRowIndices, BufferRowIndex initBufferRowIndex, std::function callWhenDone) { diff --git a/src/dialogs/country_dialog.cpp b/src/dialogs/country_dialog.cpp index d232be69..c8d46fa6 100644 --- a/src/dialogs/country_dialog.cpp +++ b/src/dialogs/country_dialog.cpp @@ -165,7 +165,6 @@ void CountryDialog::aboutToClose() * @param mainWindow The application's main window. * @param db The project database. * @param callWhenDone The function to call after the dialog has closed. - * @return The index of the new country in the database's country table buffer. */ void openNewCountryDialogAndStore(QWidget& parent, QMainWindow& mainWindow, Database& db, std::function callWhenDone) { @@ -198,7 +197,6 @@ void openNewCountryDialogAndStore(QWidget& parent, QMainWindow& mainWindow, Data * @param db The project database. * @param bufferRowIndex The index of the country to edit in the database's country table buffer. * @param callWhenDone The function to call after the dialog has closed. - * @return True if any changes were made, false otherwise. */ void openEditCountryDialogAndStore(QWidget& parent, QMainWindow& mainWindow, Database& db, BufferRowIndex bufferRowIndex, std::function callWhenDone) { @@ -236,7 +234,6 @@ void openEditCountryDialogAndStore(QWidget& parent, QMainWindow& mainWindow, Dat * @param bufferRowIndices The buffer row indices of the countries to edit. * @param initBufferRowIndex The index of the country whose data to initialize the dialog with. * @param callWhenDone The function to call after the dialog has closed. - * @return True if any changes were made, false otherwise. */ void openMultiEditCountriesDialogAndStore(QWidget& parent, QMainWindow& mainWindow, Database& db, const QSet& bufferRowIndices, BufferRowIndex initBufferRowIndex, std::function callWhenDone) { diff --git a/src/dialogs/hiker_dialog.cpp b/src/dialogs/hiker_dialog.cpp index efbb8605..7fe0ccce 100644 --- a/src/dialogs/hiker_dialog.cpp +++ b/src/dialogs/hiker_dialog.cpp @@ -165,7 +165,6 @@ void HikerDialog::aboutToClose() * @param mainWindow The application's main window. * @param db The project database. * @param callWhenDone The function to call after the dialog has closed. - * @return The index of the new hiker in the database's hiker table buffer. */ void openNewHikerDialogAndStore(QWidget& parent, QMainWindow& mainWindow, Database& db, std::function callWhenDone) { @@ -198,7 +197,6 @@ void openNewHikerDialogAndStore(QWidget& parent, QMainWindow& mainWindow, Databa * @param db The project database. * @param bufferRowIndex The index of the hiker to edit in the database's hiker table buffer. * @param callWhenDone The function to call after the dialog has closed. - * @return True if any changes were made, false otherwise. */ void openEditHikerDialogAndStore(QWidget& parent, QMainWindow& mainWindow, Database& db, BufferRowIndex bufferRowIndex, std::function callWhenDone) { @@ -236,7 +234,6 @@ void openEditHikerDialogAndStore(QWidget& parent, QMainWindow& mainWindow, Datab * @param bufferRowIndices The buffer row indices of the hikers to edit. * @param initBufferRowIndex The index of the hiker whose data to initialize the dialog with. * @param callWhenDone The function to call after the dialog has closed. - * @return True if any changes were made, false otherwise. */ void openMultiEditHikersDialogAndStore(QWidget& parent, QMainWindow& mainWindow, Database& db, const QSet& bufferRowIndices, BufferRowIndex initBufferRowIndex, std::function callWhenDone) { diff --git a/src/dialogs/peak_dialog.cpp b/src/dialogs/peak_dialog.cpp index f46fcdd3..8956bd13 100644 --- a/src/dialogs/peak_dialog.cpp +++ b/src/dialogs/peak_dialog.cpp @@ -255,7 +255,6 @@ void PeakDialog::aboutToClose() * @param mainWindow The application's main window. * @param db The project database. * @param callWhenDone The function to call after the dialog has closed. - * @return The index of the new peak in the database's peak table buffer. */ void openNewPeakDialogAndStore(QWidget& parent, QMainWindow& mainWindow, Database& db, std::function callWhenDone) { @@ -288,7 +287,6 @@ void openNewPeakDialogAndStore(QWidget& parent, QMainWindow& mainWindow, Databas * @param db The project database. * @param bufferRowIndex The index of the peak to duplicate in the database's peak table buffer. * @param callWhenDone The function to call after the dialog has closed. - * @return The index of the new peak in the database's peak table buffer. */ void openDuplicatePeakDialogAndStore(QWidget& parent, QMainWindow& mainWindow, Database& db, BufferRowIndex bufferRowIndex, std::function callWhenDone) { @@ -324,7 +322,6 @@ void openDuplicatePeakDialogAndStore(QWidget& parent, QMainWindow& mainWindow, D * @param db The project database. * @param bufferRowIndex The index of the peak to edit in the database's peak table buffer. * @param callWhenDone The function to call after the dialog has closed. - * @return True if any changes were made, false otherwise. */ void openEditPeakDialogAndStore(QWidget& parent, QMainWindow& mainWindow, Database& db, BufferRowIndex bufferRowIndex, std::function callWhenDone) { @@ -362,7 +359,6 @@ void openEditPeakDialogAndStore(QWidget& parent, QMainWindow& mainWindow, Databa * @param bufferRowIndices The buffer row indices of the peaks to edit. * @param initBufferRowIndex The index of the peak whose data to initialize the dialog with. * @param callWhenDone The function to call after the dialog has closed. - * @return True if any changes were made, false otherwise. */ void openMultiEditPeaksDialogAndStore(QWidget& parent, QMainWindow& mainWindow, Database& db, const QSet& bufferRowIndices, BufferRowIndex initBufferRowIndex, std::function callWhenDone) { diff --git a/src/dialogs/range_dialog.cpp b/src/dialogs/range_dialog.cpp index 17971399..57d78131 100644 --- a/src/dialogs/range_dialog.cpp +++ b/src/dialogs/range_dialog.cpp @@ -183,7 +183,6 @@ void RangeDialog::aboutToClose() * @param mainWindow The application's main window. * @param db The project database. * @param callWhenDone The function to call after the dialog has closed. - * @return The index of the new range in the database's range table buffer. */ void openNewRangeDialogAndStore(QWidget& parent, QMainWindow& mainWindow, Database& db, std::function callWhenDone) { @@ -216,7 +215,6 @@ void openNewRangeDialogAndStore(QWidget& parent, QMainWindow& mainWindow, Databa * @param db The project database. * @param bufferRowIndex The index of the range to edit in the database's range table buffer. * @param callWhenDone The function to call after the dialog has closed. - * @return True if any changes were made, false otherwise. */ void openEditRangeDialogAndStore(QWidget& parent, QMainWindow& mainWindow, Database& db, BufferRowIndex bufferRowIndex, std::function callWhenDone) { @@ -254,7 +252,6 @@ void openEditRangeDialogAndStore(QWidget& parent, QMainWindow& mainWindow, Datab * @param bufferRowIndices The buffer row indices of the ranges to edit. * @param initBufferRowIndex The index of the range whose data to initialize the dialog with. * @param callWhenDone The function to call after the dialog has closed. - * @return True if any changes were made, false otherwise. */ void openMultiEditRangesDialogAndStore(QWidget& parent, QMainWindow& mainWindow, Database& db, const QSet& bufferRowIndices, BufferRowIndex initBufferRowIndex, std::function callWhenDone) { diff --git a/src/dialogs/region_dialog.cpp b/src/dialogs/region_dialog.cpp index c5955d33..5a490c0d 100644 --- a/src/dialogs/region_dialog.cpp +++ b/src/dialogs/region_dialog.cpp @@ -241,7 +241,6 @@ void RegionDialog::aboutToClose() * @param mainWindow The application's main window. * @param db The project database. * @param callWhenDone The function to call after the dialog has closed. - * @return The index of the new region in the database's region table buffer. */ void openNewRegionDialogAndStore(QWidget& parent, QMainWindow& mainWindow, Database& db, std::function callWhenDone) { @@ -274,7 +273,6 @@ void openNewRegionDialogAndStore(QWidget& parent, QMainWindow& mainWindow, Datab * @param db The project database. * @param bufferRowIndex The index of the region to edit in the database's region table buffer. * @param callWhenDone The function to call after the dialog has closed. - * @return True if any changes were made, false otherwise. */ void openEditRegionDialogAndStore(QWidget& parent, QMainWindow& mainWindow, Database& db, BufferRowIndex bufferRowIndex, std::function callWhenDone) { @@ -312,7 +310,6 @@ void openEditRegionDialogAndStore(QWidget& parent, QMainWindow& mainWindow, Data * @param bufferRowIndices The buffer row indices of the regions to edit. * @param initBufferRowIndex The index of the region whose data to initialize the dialog with. * @param callWhenDone The function to call after the dialog has closed. - * @return True if any changes were made, false otherwise. */ void openMultiEditRegionsDialogAndStore(QWidget& parent, QMainWindow& mainWindow, Database& db, const QSet& bufferRowIndices, BufferRowIndex initBufferRowIndex, std::function callWhenDone) { diff --git a/src/dialogs/trip_dialog.cpp b/src/dialogs/trip_dialog.cpp index 7d809a7d..de4bb34b 100644 --- a/src/dialogs/trip_dialog.cpp +++ b/src/dialogs/trip_dialog.cpp @@ -234,7 +234,6 @@ void TripDialog::aboutToClose() * @param mainWindow The application's main window. * @param db The project database. * @param callWhenDone The function to call after the dialog has closed. - * @return The index of the new trip in the database's trip table buffer. */ void openNewTripDialogAndStore(QWidget& parent, QMainWindow& mainWindow, Database& db, std::function callWhenDone) { @@ -267,7 +266,6 @@ void openNewTripDialogAndStore(QWidget& parent, QMainWindow& mainWindow, Databas * @param db The project database. * @param bufferRowIndex The index of the trip to edit in the database's trip table buffer. * @param callWhenDone The function to call after the dialog has closed. - * @return True if any changes were made, false otherwise. */ void openEditTripDialogAndStore(QWidget& parent, QMainWindow& mainWindow, Database& db, BufferRowIndex bufferRowIndex, std::function callWhenDone) { @@ -305,7 +303,6 @@ void openEditTripDialogAndStore(QWidget& parent, QMainWindow& mainWindow, Databa * @param bufferRowIndices The buffer row indices of the trips to edit. * @param initBufferRowIndex The index of the trip whose data to initialize the dialog with. * @param callWhenDone The function to call after the dialog has closed. - * @return True if any changes were made, false otherwise. */ void openMultiEditTripsDialogAndStore(QWidget& parent, QMainWindow& mainWindow, Database& db, const QSet& bufferRowIndices, BufferRowIndex initBufferRowIndex, std::function callWhenDone) { diff --git a/src/settings/project_settings.cpp b/src/settings/project_settings.cpp index 0f5d8a46..8915681d 100644 --- a/src/settings/project_settings.cpp +++ b/src/settings/project_settings.cpp @@ -79,7 +79,7 @@ QVariant GenericProjectSetting::getDefaultAsQVariant() const /** * Sets the given value for the setting in the project settings storage. * - * @param parent The parent window. Cannot be nullptr. + * @param parent The parent window. * @param value The new value for the setting. */ void GenericProjectSetting::set(QWidget& parent, QVariant value) const @@ -89,8 +89,8 @@ void GenericProjectSetting::set(QWidget& parent, QVariant value) const /** * Clears the setting in the project settings storage. - * - * @param parent The parent window. Cannot be nullptr. + * + * @param parent The parent window. */ void GenericProjectSetting::clear(QWidget& parent) const { @@ -99,8 +99,8 @@ void GenericProjectSetting::clear(QWidget& parent) const /** * Removes the setting from the project settings storage completely. - * - * @param parent The parent window. Cannot be nullptr. + * + * @param parent The parent window. */ void GenericProjectSetting::remove(QWidget& parent) const { @@ -114,7 +114,7 @@ void GenericProjectSetting::remove(QWidget& parent) const /** * Creates a new GenericProjectSetting. * - * @param settingsTable The project settings table. + * @param table The project settings table. * @param key The key of the setting. * @param defaultValue The default value for the setting. */ @@ -170,6 +170,7 @@ template class ProjectSetting; /** * Creates a new ProjectMultiSetting with the given base key and default value. * + * @param table The project settings table. * @param baseKey The common part of the keys under which the settings will be stored. * @param defaultValue The default value for all the settings. */ @@ -266,8 +267,9 @@ T ProjectMultiSetting::getDefault() const /** * Sets the value of the setting. - * - * @param values The new values for the settings. + * + * @param parent The parent window. + * @param subKeyValueMap The new values for the settings as a map of keys and values. */ template void ProjectMultiSetting::set(QWidget& parent, const QMap& subKeyValueMap) diff --git a/src/settings/settings.h b/src/settings/settings.h index a4bf7b64..d43b4588 100644 --- a/src/settings/settings.h +++ b/src/settings/settings.h @@ -240,7 +240,7 @@ class MultiSetting /** * Sets the value of the setting. * - * @param values The new values for the settings. + * @param subKeyValueMap The new values for the settings as a map of keys and values. */ inline void set(const QMap& subKeyValueMap) { diff --git a/src/stats/chart.cpp b/src/stats/chart.cpp index 78ade806..1ec088bb 100644 --- a/src/stats/chart.cpp +++ b/src/stats/chart.cpp @@ -684,7 +684,7 @@ void TimeScatterChart::reset() * * Performs a view update after generating and storing the new data series. * - * @param newSeries A list of data series to display in the chart. + * @param seriesData A list of data series to display in the chart. * @param newMinDate The minimum x-value (date) among all given data series. * @param newMaxDate The maximum x-value (date) among all given data series. * @param newMaxY The maximum y value among all given data series. diff --git a/src/stats/stats_engine.cpp b/src/stats/stats_engine.cpp index 62412c21..746cae67 100644 --- a/src/stats/stats_engine.cpp +++ b/src/stats/stats_engine.cpp @@ -634,8 +634,6 @@ void ItemStatsEngine::setRangesPinned(bool rangesPinned) /** * Regenerates all charts from scratch or from (partial) caches if the dirty flag is set. - * - * @param selectedBufferRows The buffer rows of all items currently selected in the UI table. */ void ItemStatsEngine::updateCharts() { diff --git a/src/stats/stats_listeners.h b/src/stats/stats_listeners.h index 887e7268..679e88f3 100644 --- a/src/stats/stats_listeners.h +++ b/src/stats/stats_listeners.h @@ -16,7 +16,7 @@ */ /** - * @file stats_linsteners.h + * @file stats_listeners.h * * This file declares the TableChangeListenerGeneralStatsEngine and * TableChangeListenerItemStatsEngine classes.