diff options
author | Sam Thursfield <sam.thursfield@codethink.co.uk> | 2016-01-27 16:45:55 +0100 |
---|---|---|
committer | Sam Thursfield <sam.thursfield@codethink.co.uk> | 2016-01-27 16:45:55 +0100 |
commit | f3f6ca8ddfdb5c46cf6e9e4e26b91b1a1a132cdf (patch) | |
tree | 28daf97088b9f9c76f7a6e92d578e09f39dea5ef /doc | |
parent | 4671149722e8718fb67b64b274c07f6484e67708 (diff) | |
download | xdg-app-f3f6ca8ddfdb5c46cf6e9e4e26b91b1a1a132cdf.tar.gz |
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.
Diffstat (limited to 'doc')
-rw-r--r-- | doc/reference/Makefile.am | 3 | ||||
-rw-r--r-- | doc/reference/xdg-app-sections.txt | 57 |
2 files changed, 59 insertions, 1 deletions
diff --git a/doc/reference/Makefile.am b/doc/reference/Makefile.am index 82bd544..3d9af1b 100644 --- a/doc/reference/Makefile.am +++ b/doc/reference/Makefile.am @@ -2,7 +2,8 @@ DOC_MODULE = xdg-app DOC_MAIN_SGML_FILE = xdg-app-docs.xml DOC_SOURCE_DIR = $(top_srcdir)/lib $(top_builddir)/lib -SCAN_OPTIONS = --rebuild-types +SCAN_OPTIONS = --rebuild-types \ + --ignore-decorators='XDG_APP_EXTERN' SCANGOBJ_OPTIONS = MKDB_OPTIONS = --output-format=xml --name-space=xdg_app FIXXREF_OPTIONS = diff --git a/doc/reference/xdg-app-sections.txt b/doc/reference/xdg-app-sections.txt index 635f239..b9cfed0 100644 --- a/doc/reference/xdg-app-sections.txt +++ b/doc/reference/xdg-app-sections.txt @@ -3,6 +3,30 @@ <TITLE>XdgAppInstallation</TITLE> XdgAppInstallation XdgAppInstallationClass +xdg_app_installation_create_monitor +xdg_app_installation_fetch_remote_metadata_sync +xdg_app_installation_fetch_remote_ref_sync +xdg_app_installation_fetch_remote_size_sync +xdg_app_installation_get_current_installed_app +xdg_app_installation_get_installed_ref +xdg_app_installation_get_is_user +xdg_app_installation_get_type +xdg_app_installation_install +xdg_app_installation_launch +xdg_app_installation_list_installed_refs +xdg_app_installation_list_installed_refs_by_kind +xdg_app_installation_list_installed_refs_for_update +xdg_app_installation_list_remote_refs_sync +xdg_app_installation_list_remotes +xdg_app_installation_load_app_overrides +xdg_app_installation_new_for_path +xdg_app_installation_new_system +xdg_app_installation_new_user +xdg_app_installation_uninstall +xdg_app_installation_update +xdg_app_installation_update_appstream_sync +XdgAppProgressCallback +XdgAppUpdateFlags <SUBSECTION Standard> XDG_APP_INSTALLATION XDG_APP_IS_INSTALLATION @@ -14,6 +38,13 @@ XDG_APP_TYPE_INSTALLATION <TITLE>XdgAppInstalledRef</TITLE> XdgAppInstalledRef XdgAppInstalledRefClass +xdg_app_installed_ref_get_deploy_dir +xdg_app_installed_ref_get_installed_size +xdg_app_installed_ref_get_is_current +xdg_app_installed_ref_get_latest_commit +xdg_app_installed_ref_get_origin +xdg_app_installed_ref_get_type +xdg_app_installed_ref_load_metadata <SUBSECTION Standard> XDG_APP_INSTALLED_REF XDG_APP_IS_INSTALLED_REF @@ -25,6 +56,9 @@ XDG_APP_TYPE_INSTALLED_REF <TITLE>XdgAppRemoteRef</TITLE> XdgAppRemoteRef XdgAppRemoteRefClass +xdg_app_remote_ref_get_remote_name +xdg_app_remote_ref_get_type +xdg_app_remote_ref_new <SUBSECTION Standard> XDG_APP_IS_REMOTE_REF XDG_APP_REMOTE_REF @@ -37,6 +71,14 @@ XDG_APP_TYPE_REMOTE_REF XdgAppRef XdgAppRefClass XdgAppRefKind +xdg_app_ref_format_ref +xdg_app_ref_get_arch +xdg_app_ref_get_branch +xdg_app_ref_get_commit +xdg_app_ref_get_kind +xdg_app_ref_get_name +xdg_app_ref_get_type +xdg_app_ref_parse <SUBSECTION Standard> XDG_APP_IS_REF XDG_APP_REF @@ -48,6 +90,15 @@ XDG_APP_TYPE_REF <TITLE>XdgAppRemote</TITLE> XdgAppRemote XdgAppRemoteClass +xdg_app_remote_get_appstream_dir +xdg_app_remote_get_appstream_timestamp +xdg_app_remote_get_gpg_verify +xdg_app_remote_get_name +xdg_app_remote_get_noenumerate +xdg_app_remote_get_prio +xdg_app_remote_get_title +xdg_app_remote_get_type +xdg_app_remote_get_url <SUBSECTION Standard> XDG_APP_IS_REMOTE XDG_APP_REMOTE @@ -62,3 +113,9 @@ XDG_APP_MICRO_VERSION XDG_APP_EXTERN </SECTION> +<SECTION> +<FILE>xdg-app-error</FILE> +XDG_APP_ERROR +XdgAppError +xdg_app_error_quark +</SECTION> |