Commit 63282efb authored by David Jarvie's avatar David Jarvie

Minor doxygen related fixes

parent 5f3daf45
......@@ -191,7 +191,7 @@ class AkonadiModel : public Akonadi::EntityTreeModel
* create/delete/change rights and compatible with the current KAlarm
* calendar format.
*
* @param collection The collection to be inspected.
* @param collection The collection to be inspected
* @param format Updated to contain the backend calendar storage format.
* If read-only, = KACalendar::Current;
* if unknown format, = KACalendar::Incompatible;
......@@ -201,7 +201,7 @@ class AkonadiModel : public Akonadi::EntityTreeModel
* -1 = read-only (if @p compat == KACalendar::Current), or
* incompatible format otherwise.
*/
static int isWritable(const Akonadi::Collection&, KACalendar::Compat& format);
static int isWritable(const Akonadi::Collection& collection, KACalendar::Compat& format);
static CalEvent::Types types(const Akonadi::Collection&);
......@@ -211,12 +211,14 @@ class AkonadiModel : public Akonadi::EntityTreeModel
/** Signal emitted when a collection has been added to the model. */
void collectionAdded(const Akonadi::Collection&);
/** Signal emitted when a collection's enabled or read-only status has changed.
* @param newValue The value that has veen changed.
/** Signal emitted when a collection's enabled, read-only or alarm types
* status has changed.
* @param change The type of status which has changed
* @param newValue The new value of the status that has changed
* @param inserted true if the reason for the change is that the collection
* has been inserted into the model
*/
void collectionStatusChanged(const Akonadi::Collection&, AkonadiModel::Change, const QVariant& newValue, bool inserted);
void collectionStatusChanged(const Akonadi::Collection&, AkonadiModel::Change change, const QVariant& newValue, bool inserted);
/** Signal emitted when events have been added to the model. */
void eventsAdded(const AkonadiModel::EventList&);
......
......@@ -54,8 +54,8 @@ class CalendarMigrator : public QObject
Q_SIGNALS:
/** Signal emitted when a resource is about to be created, and when creation has
* completed (successfully or not).
* @param path path of the resource
* @param id collection ID if @p finished is @c true, else invalid
* @param path path of the resource
* @param id collection ID if @p finished is @c true, else invalid
* @param finished @c true if finished, @c false otherwise
*/
void creating(const QString& path, Akonadi::Collection::Id id, bool finished);
......
......@@ -196,8 +196,8 @@ class CollectionControlModel : public Akonadi::FavoriteCollectionsModel
* with the current KAlarm calendar format.
* Optionally, the enabled status can be ignored.
*
* @param collection The collection.
* @param type The alarm type.
* @param collection The collection
* @param type The alarm type
* @param format If the reply is false, and the calendar is not read-only
* but its backend calendar storage format is not the
* current KAlarm format, @p format is set to the calendar
......@@ -210,15 +210,15 @@ class CollectionControlModel : public Akonadi::FavoriteCollectionsModel
* -1 = read-only (if @p format == KACalendar::Current), or
* disabled or incompatible format.
*/
static int isWritableEnabled(const Akonadi::Collection&, CalEvent::Type, KACalendar::Compat& format);
static int isWritableEnabled(const Akonadi::Collection& collection, CalEvent::Type type, KACalendar::Compat& format);
/** Return the standard collection for a specified mime type.
* @param type The MIME type.
* @param type The mime type
* @param useDefault false to return the defined standard collection, if any;
* true to return the standard or only collection for the type.
* Reply = invalid collection if there is no standard collection.
*/
static Akonadi::Collection getStandard(CalEvent::Type, bool useDefault = false);
static Akonadi::Collection getStandard(CalEvent::Type type, bool useDefault = false);
/** Return whether a collection is the standard collection for a specified
* mime type. */
......@@ -251,13 +251,13 @@ class CollectionControlModel : public Akonadi::FavoriteCollectionsModel
/** Find the collection to be used to store an event of a given type.
* This will be the standard collection for the type, but if this is not valid,
* the user will be prompted to select a collection.
* @param type The given type.
* @param promptparent The parent widget for the prompt.
* @param noPrompt don't prompt the user even if the standard collection is not valid
* @param cancelled If non-null: set to true if the user cancelled
* the prompt dialogue; set to false if any other error.
* @param type The event type
* @param promptParent The parent widget for the prompt
* @param noPrompt Don't prompt the user even if the standard collection is not valid
* @param cancelled If non-null: set to true if the user cancelled the
* prompt dialogue; set to false if any other error
*/
static Akonadi::Collection destination(CalEvent::Type, QWidget* promptparent = nullptr, bool noPrompt = false, bool* cancelled = nullptr);
static Akonadi::Collection destination(CalEvent::Type type, QWidget* promptParent = nullptr, bool noPrompt = false, bool* cancelled = nullptr);
/** Return the enabled collections which contain a specified mime type.
* If 'writable' is true, only writable collections are included.
......
......@@ -182,10 +182,10 @@ bool setRtcWakeTime(unsigned triggerTime, QWidget* parent);
/** Return a prompt string to ask the user whether to convert the calendar to the
* current format.
* @param calendarName The calendar name.
* @param calendarVersion The calendar version.
* @param whole if true, the whole calendar needs to be converted; else only some
* alarms may need to be converted.
* @param calendarName The calendar name
* @param calendarVersion The calendar version
* @param whole If true, the whole calendar needs to be converted; else
* only some alarms may need to be converted.
*/
QString conversionPrompt(const QString& calendarName, const QString& calendarVersion, bool whole);
......
......@@ -40,8 +40,8 @@ class ItemListModel : public Akonadi::EntityMimeTypeFilterModel
Q_OBJECT
public:
/** Constructor.
* @param allowed the alarm types (active/archived/template) included in this model
* @param parent The parent widget.
* @param allowed The alarm types (active/archived/template) included in this model
* @param parent The parent object
*/
explicit ItemListModel(CalEvent::Types allowed, QObject* parent = nullptr);
......
......@@ -149,8 +149,8 @@ class KAMessageBox
* @param buttonContinue The text for the first button (default = "Continue")
* @param buttonCancel The text for the second button (default = "Cancel")
* @param dontAskAgainName If specified, the message box will only be suppressed
* if the user chose Continue last time.
* @param options Other options.
* if the user chose Continue last time
* @param options Other options
*/
static int warningCancelContinue(QWidget* parent, const QString& text, const QString& caption = QString(),
const KGuiItem& buttonContinue = KStandardGuiItem::cont(),
......
......@@ -53,34 +53,34 @@ class PickFileRadio : public RadioButton
Q_OBJECT
public:
/** Constructor.
* @param button Push button to invoke the file picker dialog.
* @param edit File name edit widget, or null if there is none.
* @param text Radio button's text.
* @param group The button group.
* @param parent Button group which is to be the parent object for the radio button.
* @param button Push button to invoke the file picker dialog
* @param edit File name edit widget, or null if there is none
* @param text Radio button's text
* @param group The button group which the radio button will be part of
* @param parent Button group which is to be the parent object for the radio button
*/
PickFileRadio(QPushButton* button, LineEdit* edit, const QString& text, ButtonGroup* group, QWidget* parent);
/** Constructor.
* The init() method must be called before the widget can be used.
* @param text Radio button's text.
* @param group The button group.
* @param parent Button group which is to be the parent object for the radio button.
* @param text Radio button's text
* @param group The button group which the radio button will be part of
* @param parent Button group which is to be the parent object for the radio button
*/
PickFileRadio(const QString& text, ButtonGroup* group, QWidget* parent);
/** Initialises the widget.
* @param button Push button to invoke the file picker dialog.
* @param edit File name edit widget, or null if there is none.
* @param button Push button to invoke the file picker dialog
* @param edit File name edit widget, or null if there is none
*/
void init(QPushButton* button, LineEdit* edit = nullptr);
/** Sets whether the radio button and associated widgets are read-only for the user.
* If read-only, their states cannot be changed by the user.
* @param readOnly True to set the widgets read-only, false to set them read-write.
* @param readOnly true to set the widgets read-only, false to set them read-write
*/
void setReadOnly(bool readOnly) override;
/** Chooses a file, for example by displaying a file selection dialog.
* This method is called when the push button is clicked - the client
* should not activate a file selection dialog directly.
* @return Selected file name, or QString() if no selection made.
* @return Selected file name, or QString() if no selection made
*/
virtual QString pickFile() = 0;
/** Notifies the widget of the currently selected file name.
......
......@@ -603,7 +603,7 @@ void ResourceSelector::showInfo()
name, id, calType, alarmTypeString, storage, location, perms, enabled, std);
// Display the collection information. Because the user requested
// the information, don't raise a KNotify event.
KAMessageBox::information(this, text, QString(), QString(), nullptr);
KAMessageBox::information(this, text, QString(), QString(), 0);
}
}
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment