mirror/flatpak
1
0
Fork 0
mirror of https://github.com/flatpak/flatpak.git synced 2026-05-04 05:56:28 -04:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #3277 from mwleeds/minor-doc-fixes

Browse Source 
common: Minor doc fixes
This commit is contained in:
Matthias Clasen
2019-12-03 09:04:19 -05:00
committed by GitHub
parent d4a3897d5e 17660cab57
commit 2dc0554f10
3 changed files with 19 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
common/flatpak-error.h
View File

@@ -38,7 +38,7 @@ G_BEGIN_DECLS
* @FLATPAK_ERROR_ONLY_PULLED: App/runtime was only pulled into the local
* repository but not installed.
* @FLATPAK_ERROR_DIFFERENT_REMOTE: The App/Runtime is already installed, but from a different remote.
* @FLATPAK_ERROR_ABORTED: The transaction was aborted (returned TRUE in operation-error signal).
* @FLATPAK_ERROR_ABORTED: The transaction was aborted (returned %TRUE in operation-error signal).
* @FLATPAK_ERROR_SKIPPED: The App/Runtime install was skipped due to earlier errors.
* @FLATPAK_ERROR_NEED_NEW_FLATPAK: The App/Runtime needs a more recent version of flatpak.
* @FLATPAK_ERROR_REMOTE_NOT_FOUND: The specified remote was not found.

8
common/flatpak-installation.c
View File

@@ -2962,13 +2962,13 @@ flatpak_installation_create_monitor (FlatpakInstallation *self,
* @ref. For instance, locale data or debug information.
*
* The returned list contains all available related refs, but not
* everyone should always be installed. For example,
* flatpak_related_ref_should_download () returns TRUE if the
* every one should always be installed. For example,
* flatpak_related_ref_should_download() returns %TRUE if the
* reference should be installed/updated with the app, and
* flatpak_related_ref_should_delete () returns TRUE if it
* flatpak_related_ref_should_delete() returns %TRUE if it
* should be uninstalled with the main ref.
*
* The commit property of each FlatpakRelatedRef is not guaranteed to be
* The commit property of each #FlatpakRelatedRef is not guaranteed to be
* non-%NULL.
*
* Returns: (transfer container) (element-type FlatpakRelatedRef): a GPtrArray of

25
common/flatpak-transaction.c
View File

@@ -1148,18 +1148,21 @@ flatpak_transaction_class_init (FlatpakTransactionClass *klass)
* @url: The url to show
* @id: The id of the operation, can be used to cancel it
*
* The ::webflow-start signal gets emitted when some kind of user authentication is needed
* during the operation. If the caller handles this it should show the url in a webbrowser
* and return TRUE. This will eventually cause the webbrowser to finish the authentication
* operation and operation will continue, as signaled by the webflow-done being emitted.
* The ::webflow-start signal gets emitted when some kind of user
* authentication is needed during the operation. If the caller handles this
* it should show the url in a webbrowser and return %TRUE. This will
* eventually cause the webbrowser to finish the authentication operation and
* operation will continue, as signaled by the webflow-done being emitted.
*
* If the client does not support webflow then return FALSE from this signal (or don't
* implement it). This will abort the authentication and likely result in the transaction
* failing (unless the authentication was somehow optional).
* If the client does not support webflow then return %FALSE from this signal
* (or don't implement it). This will abort the authentication and likely
* result in the transaction failing (unless the authentication was somehow
* optional).
*
* During the time between webflow-start and webflow-done the client can call flatpak_transaction_abort_webflow()
* to manually abort the authentication. This is useful if the user aborted the authentication
* operation some way, like e.g. closing the browser window.
* During the time between webflow-start and webflow-done the client can call
* flatpak_transaction_abort_webflow() to manually abort the authentication.
* This is useful if the user aborted the authentication operation some way,
* like e.g. closing the browser window.
*
* Since: 1.5.1
*/
@@ -2798,7 +2801,7 @@ request_tokens_webflow_done (FlatpakAuthenticatorRequest *object,
*
* Cancel an ongoing webflow authentication request. This can be call
* in the time between #FlatpakTransaction::webflow-start returned
* TRUE, and #FlatpakTransaction::webflow-done is emitted. It will
* %TRUE, and #FlatpakTransaction::webflow-done is emitted. It will
* cancel the ongoing authentication operation.
*
* This is useful for example if you're showing an authenticaion