Skip to content
GitLab
Menu
Projects
Groups
Snippets
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Menu
Open sidebar
PIM
KAlarm
Commits
8e89ba2e
Commit
8e89ba2e
authored
Jan 21, 2021
by
David Jarvie
Browse files
Improve API documentation
parent
61ed4e89
Changes
1
Hide whitespace changes
Inline
Side-by-side
src/kaevent.h
View file @
8e89ba2e
...
...
@@ -1227,7 +1227,8 @@ public:
/** Return the repetition interval as text suitable for display. */
QString
repetitionText
(
bool
brief
=
false
)
const
;
/** Determine whether the event will occur after the specified date/time.
/** Determine whether the event will occur strictly after the specified
* date/time. Reminders are ignored.
* @param preDateTime the specified date/time.
* @param includeRepetitions if true and the alarm has a sub-repetition, the
* method will return true if any sub-repetitions
...
...
@@ -1246,8 +1247,8 @@ public:
*/
OccurType
setNextOccurrence
(
const
KADateTime
&
preDateTime
);
/** Get the date/time of the next occurrence of the event,
after the specified
*
date/time
.
/** Get the date/time of the next occurrence of the event,
strictly after
*
the specified date/time. Reminders are ignored
.
* @param preDateTime the specified date/time.
* @param result date/time of next occurrence, or invalid date/time if none.
* @param option how/whether to make allowance for sub-repetitions.
...
...
@@ -1255,8 +1256,8 @@ public:
*/
OccurType
nextOccurrence
(
const
KADateTime
&
preDateTime
,
DateTime
&
result
,
OccurOption
option
=
IGNORE_REPETITION
)
const
;
/** Get the date/time of the last previous occurrence of the event,
before the
* s
pecified date/time
.
/** Get the date/time of the last previous occurrence of the event,
* s
trictly before the specified date/time. Reminders are ignored
.
* @param afterDateTime the specified date/time.
* @param result date/time of previous occurrence, or invalid
* date/time if none.
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment