summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorAlexander Larsson <alexl@redhat.com>2018-05-29 12:13:34 +0200
committerAlexander Larsson <alexander.larsson@gmail.com>2018-05-29 16:37:21 +0200
commit96727826949310046b39d8ed2e8dd69689014821 (patch)
tree8fad090b5ebf0c38aa1c5076bdddbf4b5d6522ef /doc
parent2642b55e91955ee95c8a8a278405927bd510391d (diff)
downloadflatpak-96727826949310046b39d8ed2e8dd69689014821.tar.gz
libflatpak: Update docs for library
Diffstat (limited to 'doc')
-rw-r--r--doc/reference/Makefile.am6
-rw-r--r--doc/reference/flatpak-docs.xml4
-rw-r--r--doc/reference/flatpak-sections.txt56
3 files changed, 63 insertions, 3 deletions
diff --git a/doc/reference/Makefile.am b/doc/reference/Makefile.am
index 5eda27e7..fc4cd6c3 100644
--- a/doc/reference/Makefile.am
+++ b/doc/reference/Makefile.am
@@ -8,10 +8,11 @@ SCANGOBJ_OPTIONS =
MKDB_OPTIONS = --output-format=xml --name-space=flatpak
FIXXREF_OPTIONS =
-HFILE_GLOB = $(top_srcdir)/common/*.h $(top_builddir)/common/*.h
+HFILE_GLOB = $(top_srcdir)/common/*.h $(top_builddir)/common/*.h
CFILE_GLOB = $(top_srcdir)/common/*.c
IGNORE_HFILES = \
+ valgrind-private.h \
flatpak-bwrap-private.h \
flatpak-chain-input-stream-private.h \
flatpak-common-types-private.h \
@@ -30,7 +31,8 @@ IGNORE_HFILES = \
flatpak-run-private.h \
flatpak-systemd-dbus-generated.h \
flatpak-transaction-private.h \
- flatpak-utils-private.h
+ flatpak-utils-private.h \
+ $(NULL)
EXTRA_HFILES =
diff --git a/doc/reference/flatpak-docs.xml b/doc/reference/flatpak-docs.xml
index 39d99f88..8a3ec2b2 100644
--- a/doc/reference/flatpak-docs.xml
+++ b/doc/reference/flatpak-docs.xml
@@ -16,11 +16,13 @@
<chapter>
<title>Flatpak</title>
<xi:include href="xml/flatpak-installation.xml"/>
+ <xi:include href="xml/flatpak-remote.xml"/>
+ <xi:include href="xml/flatpak-transaction-progress.xml"/>
+ <xi:include href="xml/flatpak-transaction.xml"/>
<xi:include href="xml/flatpak-ref.xml"/>
<xi:include href="xml/flatpak-installed-ref.xml"/>
<xi:include href="xml/flatpak-related-ref.xml"/>
<xi:include href="xml/flatpak-remote-ref.xml"/>
- <xi:include href="xml/flatpak-remote.xml"/>
<xi:include href="xml/flatpak-bundle-ref.xml"/>
<xi:include href="xml/flatpak-error.xml"/>
<xi:include href="xml/flatpak-version-macros.xml"/>
diff --git a/doc/reference/flatpak-sections.txt b/doc/reference/flatpak-sections.txt
index fcaa80b9..c0da2297 100644
--- a/doc/reference/flatpak-sections.txt
+++ b/doc/reference/flatpak-sections.txt
@@ -6,6 +6,7 @@ flatpak_installation_new_system
flatpak_installation_new_system_with_id
flatpak_installation_new_user
flatpak_installation_new_for_path
+flatpak_installation_create_transaction
flatpak_installation_get_is_user
flatpak_installation_get_path
flatpak_installation_create_monitor
@@ -27,6 +28,7 @@ flatpak_installation_list_installed_refs_by_kind
flatpak_installation_list_installed_refs_for_update
flatpak_installation_list_installed_related_refs_sync
flatpak_installation_list_remote_refs_sync
+flatpak_installation_list_remotes_by_type
flatpak_installation_list_remote_related_refs_sync
flatpak_installation_list_remotes
flatpak_installation_get_remote_by_name
@@ -74,6 +76,8 @@ flatpak_installed_ref_get_latest_commit
flatpak_installed_ref_get_origin
flatpak_installed_ref_load_metadata
flatpak_installed_ref_get_subpaths
+flatpak_installed_ref_get_eol
+flatpak_installed_ref_get_eol_rebase
<SUBSECTION Standard>
FlatpakInstalledRefClass
FLATPAK_INSTALLED_REF
@@ -87,6 +91,11 @@ flatpak_installed_ref_get_type
<TITLE>FlatpakRemoteRef</TITLE>
FlatpakRemoteRef
flatpak_remote_ref_get_remote_name
+flatpak_remote_ref_get_download_size
+flatpak_remote_ref_get_eol
+flatpak_remote_ref_get_eol_rebase
+flatpak_remote_ref_get_installed_size
+flatpak_remote_ref_get_metadata
<SUBSECTION Standard>
FLATPAK_IS_REMOTE_REF
FLATPAK_REMOTE_REF
@@ -170,6 +179,50 @@ flatpak_remote_get_type
</SECTION>
<SECTION>
+<FILE>flatpak-transaction-progress</FILE>
+<TITLE>FlatpakTransactionProgress</TITLE>
+FlatpakTransactionProgress
+flatpak_transaction_progress_get_is_estimating
+flatpak_transaction_progress_get_progress
+flatpak_transaction_progress_get_status
+flatpak_transaction_progress_set_update_frequency
+<SUBSECTION Standard>
+FlatpakTransactionProgressClass
+FLATPAK_IS_TRANSACTION_PROGRESS
+FLATPAK_TRANSACTION_PROGRESS
+FLATPAK_TYPE_TRANSACTION_PROGRESS
+flatpak_transaction_progress_get_type
+</SECTION>
+
+<SECTION>
+<FILE>flatpak-transaction</FILE>
+<TITLE>FlatpakTransaction</TITLE>
+FlatpakTransaction
+FlatpakTransactionOperationType
+FlatpakTransactionErrorDetails
+FlatpakTransactionResult
+flatpak_transaction_add_install
+flatpak_transaction_add_install_bundle
+flatpak_transaction_add_update
+flatpak_transaction_is_empty
+flatpak_transaction_run
+<SUBSECTION>
+flatpak_transaction_set_disable_dependencies
+flatpak_transaction_set_disable_prune
+flatpak_transaction_set_disable_related
+flatpak_transaction_set_disable_static_deltas
+flatpak_transaction_set_no_deploy
+flatpak_transaction_set_no_pull
+flatpak_transaction_set_reinstall
+<SUBSECTION Standard>
+FlatpakTransactionClass
+FLATPAK_IS_TRANSACTION
+FLATPAK_TRANSACTION
+FLATPAK_TYPE_TRANSACTION
+flatpak_transaction_get_type
+</SECTION>
+
+<SECTION>
<FILE>flatpak-version-macros</FILE>
FLATPAK_CHECK_VERSION
FLATPAK_MAJOR_VERSION
@@ -183,6 +236,9 @@ FLATPAK_EXTERN
FLATPAK_ERROR
FlatpakError
flatpak_error_quark
+FLATPAK_PORTAL_ERROR
+FlatpakPortalError
+flatpak_portal_error_quark
</SECTION>
<SECTION>