Commit Graph

37 Commits

Author SHA1 Message Date
Robert McQueen
8bd22682f7 installation: nitpicks
Make the new _run_triggers function appear correctly in GtkDoc and cross-link.

Closes: #2164
Approved by: alexlarsson
2018-10-02 06:22:27 +00:00
Matthias Clasen
c284777d61 Add more api docs for libflatpak
Bring the library docs much closer to completion.

Closes: #2053
Approved by: alexlarsson
2018-09-03 10:31:51 +00:00
Will Thompson
9e02d51737 docs: fix title of FlatpakBundleRef section
Closes: #1995
Approved by: alexlarsson
2018-08-27 10:57:16 +00:00
Will Thompson
9cc72ed08f transaction: improve cross-refs for signal parameter docs
Closes: #1995
Approved by: alexlarsson
2018-08-27 10:57:16 +00:00
Will Thompson
98ee688b84 docs: make FlatpakTransactionOperation appear
There were two reasons why no docs for this class appeared in the HTML
documentation:

* flatpak-transaction-operation.xml was not included by
  flatpak-docs.xml.
* all its symbols were listed in <SUBSECTION Standard>, which is hidden
  from the HTML output. It appears that if a section has no visible
  symbols, it's omitted.

Many symbols which belong to FlatpakTransaction were erroneously grouped
with FlatpakTransactionOperation and so also hidden; fix this too.

Closes: #1995
Approved by: alexlarsson
2018-08-27 10:57:15 +00:00
Alexander Larsson
adffe7d15f fixup! Add flatpak_transaction_operation_type_to_string() 2018-07-10 19:25:44 +02:00
Alexander Larsson
c0ebd3a121 transaction: Move flatpakref installation to transaction code
This adds the flatpak_transaction_add_install_flatpakref method
to easily install from flatpakref files. It additionally
adds a new signal called add-new-remote which is called in two
cases:

 To ask if the user wants to add a "normal" remote for the url
 specified by a flatpakref file.

 When a new remote is required for the runtimes the application
 depends on.

Closes: #1868
Approved by: alexlarsson
2018-07-07 15:38:46 +00:00
Alexander Larsson
1ecca029a8 transaction: Add flatpak_transaction_set_default_arch
This will be used as the default when installing something that
doesn't specify a ref, such as a flatpakref file.

Closes: #1868
Approved by: alexlarsson
2018-07-07 15:38:46 +00:00
Alexander Larsson
93ca5cdf45 transaction: Add get_installation()
Closes: #1841
Approved by: alexlarsson
2018-06-29 12:56:15 +00:00
Alexander Larsson
23f1df8a5b Transaction: Add operation getters for metadata and old_metadata
Closes: #1799
Approved by: alexlarsson
2018-06-19 14:54:22 +00:00
Alexander Larsson
1e7e6376ff gtk-doc: Add all missing symbols to flatpak.sections
Closes: #1797
Approved by: alexlarsson
2018-06-19 08:30:21 +00:00
Alexander Larsson
8df5a6af11 Fix up gtk-doc warnings 2018-05-29 16:49:44 +02:00
Alexander Larsson
9672782694 libflatpak: Update docs for library 2018-05-29 16:37:21 +02:00
Alexander Larsson
b16ae4cc18 gtk-doc: Fix up -I from move from lib/ to common/
Closes: #1729
Approved by: alexlarsson
2018-05-29 07:53:48 +00:00
Alexander Larsson
9cd5a04bb3 Fix dist for docs 2018-05-25 17:05:44 +02:00
Mario Sanchez Prada
3ee19d609d lib/installation: Adding missing documentation for the newly added API
Add FLATPAK_UPDATE_FLAGS_NO_PRUNE and flatpak_installation_uninstall_full()
to the documentation, along with a couple of small fixes.

https://github.com/flatpak/flatpak/issues/1703

Closes: #1705
Approved by: pwithnall
2018-05-23 16:55:13 +00:00
Nicholas Bishop
ab117ee250 Add all missing declarations to flatpak-sections.txt
Closes: #1505
Approved by: mwleeds
2018-03-23 22:55:11 +00:00
Nicholas Bishop
69fa452bed Add FlatpakRelatedRef to API documentation
Closes: #1497
Approved by: alexlarsson
2018-03-19 09:41:09 +00:00
Mario Sanchez Prada
38a1eeea0e Add new API to the docs
Some of this API has been added a while ago, but never
made it to the sections file, so add it now.
2017-03-27 14:11:43 +02:00
Mario Sanchez Prada
8decac7d7f Added new public API: flatpak_installation_update_remote_sync()
Provides access to the functionality offered by the new internal API
flatpak_dir_update_remote_configuration(), in a similar way to what
can be done via the command 'flatpak remote-modify --update-metadata'.
2016-10-14 16:42:17 +01:00
Matthias Clasen
0cfd001d9b Add some new api to the docs 2016-05-16 19:49:48 -04:00
Matthias Clasen
e7d53ca7cb Add new FlatpakRemote apis to the docs 2016-05-16 19:37:08 -04:00
Alexander Larsson
8abbc0186e Rename everything but the on-disk location to flatpak 2016-05-09 11:11:55 +02:00
Alexander Larsson
ba37b22d78 Rename library to libflatpak 2016-05-09 09:46:26 +02:00
Alexander Larsson
6a613d1fab Rename all non-autogenerated symbols to flatpak 2016-05-09 09:00:20 +02:00
Matthias Clasen
2a2ae8008b More class hiding 2016-03-25 11:38:41 -04:00
Matthias Clasen
516432740d doc: Add xdg_app_installation_install_bundle 2016-03-25 11:36:20 -04:00
Matthias Clasen
5f02c340b4 docs: Hide class structs
There is no intention to let any of these be subclasses,
so don't show the classes.
2016-03-25 11:33:30 -04:00
Matthias Clasen
1c41f04dbb docs: Exclude more private headers
This reduces the noise in the gtk-doc output.
2016-03-25 11:26:07 -04:00
Matthias Clasen
5f657bee2f docs: No need for a deprecated index
No deprecated APIs yet - knock on wood!
2016-03-25 11:17:40 -04:00
Matthias Clasen
7a5f874e69 docs: Pick up the version number automatically
This is copied from what GTK+ does for its docs.
2016-03-25 11:16:20 -04:00
Matthias Clasen
7873de5155 doc: Minor reshuffling 2016-03-25 10:53:26 -04:00
Simon McVittie
9a6bf95054 Disable gtkdoc-check by default for now
We know the documentation is incomplete, so there seems little value
in having 'make check' tell us that. Everything except the documentation
check is expected to succeed, so it's now more useful to report test
failures in continuous integration systems, making functional
regressions more visible.

Signed-off-by: Simon McVittie <smcv@debian.org>
2016-01-29 09:41:23 +01:00
Sam Thursfield
66cdd7b197 Document the structs in libxdg-app 2016-01-28 11:26:12 +01:00
Sam Thursfield
f3f6ca8ddf docs: Fix gtk-doc documentation
We need to explicitly tell gtk-doc about the XDG_APP_EXTERN macro,
otherwise it will ignore all of the function definitions.

Full docs are now produced. There are plenty of warnings which can be
fixed later.
2016-01-27 16:45:55 +01:00
Alexander Larsson
6c999147c4 Add XdgAppRemoteRef do docs 2015-12-04 20:22:57 +01:00
Emmanuele Bassi
f23090a615 Generate the API reference for libxdg-app
We use the good old gtk-doc.
2015-12-04 15:00:35 +00:00