colin/NetworkManager
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

cloud-setup/trivial: fix gtkdoc comment for nmcs_utils_poll()

Browse Source 
@probe_start_fcn is not called the first time synchronously. Fix the comment.
While at it, reword a bit.
This commit is contained in:
Thomas Haller
2023-02-27 15:50:44 +01:00
parent 841e06be5e
commit 1ee35cb638
1 changed files with 7 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
src/nm-cloud-setup/nm-cloud-setup-utils.c
View File

@@ -304,14 +304,15 @@ _poll_cancelled_cb(GObject *object, gpointer user_data)
* @poll_timeout_ms: if >= 0, then this is the overall timeout for how long we poll. * @poll_timeout_ms: if >= 0, then this is the overall timeout for how long we poll.
* When this timeout expires, the request completes with failure (and error set). * When this timeout expires, the request completes with failure (and error set).
* @ratelimit_timeout_ms: if > 0, we ratelimit the starts from one prope_start_fcn * @ratelimit_timeout_ms: if > 0, we ratelimit the starts from one prope_start_fcn
* call to the next. * call to the next. We will wait at least this time between two consecutive polls.
* @sleep_timeout_ms: if > 0, then we wait after a probe finished this timeout * @sleep_timeout_ms: if > 0, then we wait after a probe finished this timeout
* before the next. Together with @ratelimit_timeout_ms this determines how * before the next. Together with @ratelimit_timeout_ms this determines how
* frequently we probe. * frequently we probe. We will wait at least this time between the end of the
* @probe_start_fcn: used to start a (asynchronous) probe. A probe must be completed * previous poll and the next one.
* by calling the provided callback. While a probe is in progress, we will not * @probe_start_fcn: used to start a (asynchronous) probe. A probe must be
* start another. This function is already invoked the first time synchronously, * completed by calling the provided callback. While a probe is in progress, we
* during nmcs_utils_poll(). * will not start another. The function is called the first time on an idle
* handler, afterwards it gets called again on each timeout for polling.
* @probe_finish_fcn: will be called from the callback of @probe_start_fcn. If the * @probe_finish_fcn: will be called from the callback of @probe_start_fcn. If the
* function returns %TRUE (polling done) or an error, polling stops. Otherwise, * function returns %TRUE (polling done) or an error, polling stops. Otherwise,
* another poll will be started. * another poll will be started.