diff options
author | Robert Ancell <robert.ancell@canonical.com> | 2017-09-20 10:35:21 +1200 |
---|---|---|
committer | Robert Ancell <robert.ancell@canonical.com> | 2017-09-20 10:35:21 +1200 |
commit | 7a112f9b60b460120151fc4651c067c117f1b97a (patch) | |
tree | d2119381f6bbae797ae42ea198ea87e6bf273f74 /docs | |
parent | 4fb4e4e2f4c7dde4a893406f97615a4244caab2e (diff) |
docs: Reorder docs and add missing docstrings
Diffstat (limited to 'docs')
-rw-r--r-- | docs/api/Makefile.am | 1 | ||||
-rw-r--r-- | docs/api/PackageKit-docs.sgml | 28 | ||||
-rw-r--r-- | docs/api/PackageKit-sections.txt | 25 |
3 files changed, 14 insertions, 40 deletions
diff --git a/docs/api/Makefile.am b/docs/api/Makefile.am index 01ba36f4d..2b81e9753 100644 --- a/docs/api/Makefile.am +++ b/docs/api/Makefile.am @@ -42,6 +42,7 @@ IGNORE_HFILES = \ config.h \ pk-marshal.h \ pk-common-private.h \ + pk-debug.h \ pk-offline-private.h \ pk-spawn-polkit-agent.h \ $(NULL) diff --git a/docs/api/PackageKit-docs.sgml b/docs/api/PackageKit-docs.sgml index 939119e10..b257bb18f 100644 --- a/docs/api/PackageKit-docs.sgml +++ b/docs/api/PackageKit-docs.sgml @@ -58,17 +58,23 @@ <xi:include href="dbus/org.freedesktop.PackageKit.Transaction.ref.xml"/> </reference> - <reference id="libpackagekit-gobject"> - <title>libpackagekit GObjects</title> + <reference id="lpackagekit-glib2"> + <title>packagekit-glib2</title> <partintro> <para> - This part documents GObjects used in libpackagekit. + This part documents packagekit-glib2. </para> </partintro> + <xi:include href="xml/pk-common.xml"/> + <xi:include href="xml/pk-enum.xml"/> + <xi:include href="xml/pk-package-id.xml"/> + <xi:include href="xml/pk-offline.xml"/> + <xi:include href="xml/pk-bitfield.xml"/> <xi:include href="xml/pk-category.xml"/> <xi:include href="xml/pk-client.xml"/> <xi:include href="xml/pk-client-helper.xml"/> <xi:include href="xml/pk-control.xml"/> + <xi:include href="xml/pk-desktop.xml"/> <xi:include href="xml/pk-details.xml"/> <xi:include href="xml/pk-distro-upgrade.xml"/> <xi:include href="xml/pk-error.xml"/> @@ -90,22 +96,6 @@ <xi:include href="xml/pk-update-detail.xml"/> </reference> - <reference id="libpackagekit-helpers"> - <title>libpackagekit glib helpers</title> - <partintro> - <para> - This part documents helper funtions in libpackagekit. - </para> - </partintro> - <xi:include href="xml/pk-bitfield.xml"/> - <xi:include href="xml/pk-common.xml"/> - <xi:include href="xml/pk-desktop.xml"/> - <xi:include href="xml/pk-enum.xml"/> - <xi:include href="xml/pk-offline.xml"/> - <xi:include href="xml/pk-package-ids.xml"/> - <xi:include href="xml/pk-package-id.xml"/> - </reference> - <index id="api-index-0-5-0"> <title>Index of new symbols in 0.5.0</title> <xi:include href="xml/api-index-0.5.0.xml"/> diff --git a/docs/api/PackageKit-sections.txt b/docs/api/PackageKit-sections.txt index 9e381c9cd..62725cbf4 100644 --- a/docs/api/PackageKit-sections.txt +++ b/docs/api/PackageKit-sections.txt @@ -167,6 +167,10 @@ pk_client_helper_get_type <SECTION> <FILE>pk-common</FILE> +PK_MAJOR_VERSION +PK_MINOR_VERSION +PK_MICRO_VERSION +PK_CHECK_VERSION PK_DBUS_SERVICE PK_DBUS_PATH PK_DBUS_INTERFACE @@ -232,14 +236,6 @@ pk_control_get_type </SECTION> <SECTION> -<FILE>pk-debug</FILE> -pk_debug_is_verbose -pk_debug_get_option_group -pk_debug_add_log_domain -pk_debug_set_verbose -</SECTION> - -<SECTION> <FILE>pk-desktop</FILE> <TITLE>PkDesktop</TITLE> PK_DESKTOP_DEFAULT_DATABASE @@ -573,10 +569,6 @@ pk_package_id_check pk_package_id_split pk_package_id_to_printable pk_package_id_equal_fuzzy_arch -</SECTION> - -<SECTION> -<FILE>pk-package-ids</FILE> PK_PACKAGE_IDS_DELIM pk_package_ids_from_id pk_package_ids_from_string @@ -1011,12 +1003,3 @@ PkUpdateDetailClass PkUpdateDetailPrivate pk_update_detail_get_type </SECTION> - -<SECTION> -<FILE>pk-version</FILE> -PK_MAJOR_VERSION -PK_MINOR_VERSION -PK_MICRO_VERSION -PK_CHECK_VERSION -</SECTION> - |