From 79c747b20ba18b7e696fe75e5efb962ea50d96b8 Mon Sep 17 00:00:00 2001 From: Richard Hughes Date: Wed, 17 Jan 2018 10:14:06 +0000 Subject: Add more GObject Introspection annotations for Python --- libappstream-glib/as-app.c | 26 +++++++++++++------------- libappstream-glib/as-release.c | 4 ++-- libappstream-glib/as-screenshot.c | 6 +++--- libappstream-glib/as-store.c | 4 ++-- 4 files changed, 20 insertions(+), 20 deletions(-) diff --git a/libappstream-glib/as-app.c b/libappstream-glib/as-app.c index 78f4218..637a362 100644 --- a/libappstream-glib/as-app.c +++ b/libappstream-glib/as-app.c @@ -964,7 +964,7 @@ as_app_get_format_by_kind (AsApp *app, AsFormatKind kind) /** * as_app_get_keywords: * @app: a #AsApp instance. - * @locale: the locale, or %NULL. e.g. "en_GB" + * @locale: (nullable): the locale. e.g. "en_GB" * * Gets any keywords the application should match against. * @@ -1850,7 +1850,7 @@ as_app_get_icon_path (AsApp *app) /** * as_app_get_name: * @app: a #AsApp instance. - * @locale: the locale, or %NULL. e.g. "en_GB" + * @locale: (nullable): the locale. e.g. "en_GB" * * Gets the application name for a specific locale. * @@ -1868,7 +1868,7 @@ as_app_get_name (AsApp *app, const gchar *locale) /** * as_app_get_comment: * @app: a #AsApp instance. - * @locale: the locale, or %NULL. e.g. "en_GB" + * @locale: (nullable): the locale. e.g. "en_GB" * * Gets the application summary for a specific locale. * @@ -1886,7 +1886,7 @@ as_app_get_comment (AsApp *app, const gchar *locale) /** * as_app_get_developer_name: * @app: a #AsApp instance. - * @locale: the locale, or %NULL. e.g. "en_GB" + * @locale: (nullable): the locale. e.g. "en_GB" * * Gets the application developer name for a specific locale. * @@ -1904,7 +1904,7 @@ as_app_get_developer_name (AsApp *app, const gchar *locale) /** * as_app_get_description: * @app: a #AsApp instance. - * @locale: the locale, or %NULL. e.g. "en_GB" + * @locale: (nullable): the locale. e.g. "en_GB" * * Gets the application description markup for a specific locale. * @@ -1922,7 +1922,7 @@ as_app_get_description (AsApp *app, const gchar *locale) /** * as_app_get_language: * @app: a #AsApp instance. - * @locale: the locale, or %NULL. e.g. "en_GB" + * @locale: (nullable): the locale. e.g. "en_GB" * * Gets the language coverage for the specific language. * @@ -2648,7 +2648,7 @@ as_app_set_icon_path (AsApp *app, const gchar *icon_path) /** * as_app_set_name: * @app: a #AsApp instance. - * @locale: the locale, or %NULL. e.g. "en_GB" + * @locale: (nullable): the locale. e.g. "en_GB" * @name: the application name. * * Sets the application name for a specific locale. @@ -2682,7 +2682,7 @@ as_app_set_name (AsApp *app, /** * as_app_set_comment: * @app: a #AsApp instance. - * @locale: the locale, or %NULL. e.g. "en_GB" + * @locale: (nullable): the locale. e.g. "en_GB" * @comment: the application summary. * * Sets the application summary for a specific locale. @@ -2718,7 +2718,7 @@ as_app_set_comment (AsApp *app, /** * as_app_set_developer_name: * @app: a #AsApp instance. - * @locale: the locale, or %NULL. e.g. "en_GB" + * @locale: (nullable): the locale. e.g. "en_GB" * @developer_name: the application developer name. * * Sets the application developer name for a specific locale. @@ -2754,7 +2754,7 @@ as_app_set_developer_name (AsApp *app, /** * as_app_set_description: * @app: a #AsApp instance. - * @locale: the locale, or %NULL. e.g. "en_GB" + * @locale: (nullable): the locale. e.g. "en_GB" * @description: the application description. * * Sets the application descrption markup for a specific locale. @@ -2891,7 +2891,7 @@ as_app_add_compulsory_for_desktop (AsApp *app, const gchar *compulsory_for_deskt /** * as_app_add_keyword: * @app: a #AsApp instance. - * @locale: the locale, or %NULL. e.g. "en_GB" + * @locale: (nullable): the locale. e.g. "en_GB" * @keyword: the keyword. * * Add a keyword the application should match against. @@ -3652,7 +3652,7 @@ as_app_add_arch (AsApp *app, const gchar *arch) * as_app_add_language: * @app: a #AsApp instance. * @percentage: the percentage completion of the translation, or 0 for unknown - * @locale: the locale, or %NULL. e.g. "en_GB" + * @locale: (nullable): the locale. e.g. "en_GB" * * Adds a language to the application. * @@ -6252,7 +6252,7 @@ as_app_parse_file (AsApp *app, * as_app_to_file: * @app: a #AsApp instance. * @file: a #GFile - * @cancellable: A #GCancellable, or %NULL + * @cancellable: (nullable): A #GCancellable * @error: A #GError or %NULL * * Exports a DOM tree to an XML file. diff --git a/libappstream-glib/as-release.c b/libappstream-glib/as-release.c index 3f5d785..2b13ab3 100644 --- a/libappstream-glib/as-release.c +++ b/libappstream-glib/as-release.c @@ -454,7 +454,7 @@ as_release_get_timestamp (AsRelease *release) /** * as_release_get_description: * @release: a #AsRelease instance. - * @locale: the locale, or %NULL. e.g. "en_GB" + * @locale: (nullable): the locale. e.g. "en_GB" * * Gets the release description markup for a given locale. * @@ -602,7 +602,7 @@ as_release_set_timestamp (AsRelease *release, guint64 timestamp) /** * as_release_set_description: * @release: a #AsRelease instance. - * @locale: the locale, or %NULL. e.g. "en_GB" + * @locale: (nullable): the locale. e.g. "en_GB" * @description: the description markup. * * Sets the description release markup. diff --git a/libappstream-glib/as-screenshot.c b/libappstream-glib/as-screenshot.c index 327b20a..ab8cb92 100644 --- a/libappstream-glib/as-screenshot.c +++ b/libappstream-glib/as-screenshot.c @@ -220,7 +220,7 @@ as_screenshot_get_images_for_locale (AsScreenshot *screenshot, /** * as_screenshot_get_image_for_locale: * @screenshot: a #AsScreenshot instance. - * @locale: locale, or %NULL + * @locale: (nullable): locale, e.g. "en_GB" * @width: target width * @height: target height * @@ -314,7 +314,7 @@ as_screenshot_get_source (AsScreenshot *screenshot) /** * as_screenshot_get_caption: * @screenshot: a #AsScreenshot instance. - * @locale: the locale, or %NULL. e.g. "en_GB" + * @locale: (nullable): the locale, or %NULL. e.g. "en_GB" * * Gets the image caption for a specific locale. * @@ -382,7 +382,7 @@ as_screenshot_add_image (AsScreenshot *screenshot, AsImage *image) /** * as_screenshot_set_caption: * @screenshot: a #AsScreenshot instance. - * @locale: the locale, or %NULL. e.g. "en_GB" + * @locale: (nullable): the locale, or %NULL. e.g. "en_GB" * @caption: the caption text. * * Sets a caption on the screenshot for a specific locale. diff --git a/libappstream-glib/as-store.c b/libappstream-glib/as-store.c index 67d331d..8816f5d 100644 --- a/libappstream-glib/as-store.c +++ b/libappstream-glib/as-store.c @@ -2006,7 +2006,7 @@ as_store_from_file_internal (AsStore *store, * as_store_from_file: * @store: a #AsStore instance. * @file: a #GFile. - * @icon_root: the icon path, or %NULL for the default (unused) + * @icon_root: (nullable): the icon path, or %NULL for the default (unused) * @cancellable: a #GCancellable. * @error: A #GError or %NULL. * @@ -2098,7 +2098,7 @@ as_store_from_bytes (AsStore *store, * as_store_from_xml: * @store: a #AsStore instance. * @data: XML data - * @icon_root: the icon path, or %NULL for the default. + * @icon_root: (nullable): the icon path, or %NULL for the default. * @error: A #GError or %NULL. * * Parses AppStream XML file and adds any valid applications to the store. -- cgit v1.2.1