diff --git a/src/libvalent/clipboard/valent-clipboard-adapter.c b/src/libvalent/clipboard/valent-clipboard-adapter.c index f03d1ac72a..e90c44ed25 100644 --- a/src/libvalent/clipboard/valent-clipboard-adapter.c +++ b/src/libvalent/clipboard/valent-clipboard-adapter.c @@ -16,7 +16,7 @@ * * An abstract base class for clipboard selections. * - * #ValentClipboardAdapter is a base class for plugins that provide an interface + * `ValentClipboardAdapter` is a base class for plugins that provide an interface * to the desktop clipboard. This usually means reading and writing content, * including notification of content changes. * @@ -41,7 +41,7 @@ G_DEFINE_ABSTRACT_TYPE_WITH_PRIVATE (ValentClipboardAdapter, valent_clipboard_ad /** * ValentClipboardAdapterClass: - * @changed: class closure for #ValentClipboardAdapter::changed signal + * @changed: class closure for `ValentClipboardAdapter`::changed signal * @get_mimetypes: the virtual function pointer for valent_clipboard_adapter_get_mimetypes() * @get_timestamp: the virtual function pointer for valent_clipboard_adapter_get_timestamp() * @read_bytes: the virtual function pointer for valent_clipboard_adapter_read_bytes() @@ -49,7 +49,7 @@ G_DEFINE_ABSTRACT_TYPE_WITH_PRIVATE (ValentClipboardAdapter, valent_clipboard_ad * @write_bytes: the virtual function pointer for valent_clipboard_adapter_write_bytes() * @write_bytes_finish: the virtual function pointer for valent_clipboard_adapter_write_bytes_finish() * - * The virtual function table for #ValentClipboardAdapter. + * The virtual function table for `ValentClipboardAdapter`. */ enum { @@ -168,7 +168,7 @@ valent_clipboard_adapter_class_init (ValentClipboardAdapterClass *klass) /** * ValentClipboardAdapter::changed: - * @adapter: a #ValentClipboardAdapter + * @adapter: a `ValentClipboardAdapter` * * Emitted when the content of @adapter changes. * @@ -193,7 +193,7 @@ valent_clipboard_adapter_init (ValentClipboardAdapter *adapter) /** * valent_clipboard_adapter_changed: (virtual changed) - * @adapter: a #ValentClipboardAdapter + * @adapter: a `ValentClipboardAdapter` * * Emits [signal@Valent.ClipboardAdapter::changed] signal on @adapter. * @@ -215,7 +215,7 @@ valent_clipboard_adapter_changed (ValentClipboardAdapter *adapter) /** * valent_clipboard_adapter_get_timestamp: (virtual get_timestamp) - * @adapter: a #ValentClipboardAdapter + * @adapter: a `ValentClipboardAdapter` * * Get the timestamp of the current clipboard content. * @@ -242,7 +242,7 @@ valent_clipboard_adapter_get_timestamp (ValentClipboardAdapter *adapter) /** * valent_clipboard_adapter_get_mimetypes: (virtual get_mimetypes) - * @adapter: a #ValentClipboardAdapter + * @adapter: a `ValentClipboardAdapter` * * Get the mime-types of the current clipboard content. * @@ -267,10 +267,10 @@ valent_clipboard_adapter_get_mimetypes (ValentClipboardAdapter *adapter) /** * valent_clipboard_adapter_read_bytes: (virtual read_bytes) - * @adapter: a #ValentClipboardAdapter + * @adapter: a `ValentClipboardAdapter` * @mimetype: a mime-type - * @cancellable: (nullable): a #GCancellable - * @callback: (scope async): a #GAsyncReadyCallback + * @cancellable: (nullable): a `GCancellable` + * @callback: (scope async): a `GAsyncReadyCallback` * @user_data: (closure): user supplied data * * Get the content of @adapter. @@ -302,13 +302,13 @@ valent_clipboard_adapter_read_bytes (ValentClipboardAdapter *adapter, /** * valent_clipboard_adapter_read_bytes_finish: (virtual read_bytes_finish) - * @adapter: a #ValentClipboardAdapter - * @result: a #GAsyncResult - * @error: (nullable): a #GError + * @adapter: a `ValentClipboardAdapter` + * @result: a `GAsyncResult` + * @error: (nullable): a `GError` * * Finish an operation started by [method@Valent.ClipboardAdapter.read_bytes]. * - * Returns: (transfer full) (nullable): a #GBytes, or %NULL with @error set + * Returns: (transfer full) (nullable): a `GBytes`, or %NULL with @error set * * Since: 1.0 */ @@ -334,11 +334,11 @@ valent_clipboard_adapter_read_bytes_finish (ValentClipboardAdapter *adapter, /** * valent_clipboard_adapter_write_bytes: (virtual write_bytes) - * @adapter: a #ValentClipboardAdapter + * @adapter: a `ValentClipboardAdapter` * @mimetype: (nullable): a mime-type, or %NULL if @bytes is %NULL - * @bytes: (nullable): a #GBytes, or %NULL if @mimetype is %NULL - * @cancellable: (nullable): a #GCancellable - * @callback: (scope async): a #GAsyncReadyCallback + * @bytes: (nullable): a `GBytes`, or %NULL if @mimetype is %NULL + * @cancellable: (nullable): a `GCancellable` + * @callback: (scope async): a `GAsyncReadyCallback` * @user_data: (closure): user supplied data * * Set the content of the clipboard. @@ -373,9 +373,9 @@ valent_clipboard_adapter_write_bytes (ValentClipboardAdapter *adapter, /** * valent_clipboard_adapter_write_bytes_finish: (virtual write_bytes_finish) - * @adapter: a #ValentClipboardAdapter - * @result: a #GAsyncResult - * @error: (nullable): a #GError + * @adapter: a `ValentClipboardAdapter` + * @result: a `GAsyncResult` + * @error: (nullable): a `GError` * * Finish an operation started by [method@Valent.ClipboardAdapter.write_bytes]. * diff --git a/src/libvalent/clipboard/valent-clipboard.c b/src/libvalent/clipboard/valent-clipboard.c index 0865794431..18f8b0263a 100644 --- a/src/libvalent/clipboard/valent-clipboard.c +++ b/src/libvalent/clipboard/valent-clipboard.c @@ -18,7 +18,7 @@ * * A class for reading and writing the desktop clipboard. * - * #ValentClipboard is an abstraction of clipboard selections, intended for use + * `ValentClipboard` is an abstraction of clipboard selections, intended for use * by [class@Valent.DevicePlugin] implementations. * * Plugins can implement [class@Valent.ClipboardAdapter] to provide an interface @@ -180,7 +180,7 @@ valent_clipboard_class_init (ValentClipboardClass *klass) /** * ValentClipboard::changed: - * @clipboard: a #ValentClipboard + * @clipboard: a `ValentClipboard` * * Emitted when the content of the primary [class@Valent.ClipboardAdapter] * changes. @@ -206,7 +206,7 @@ valent_clipboard_init (ValentClipboard *self) * * Get the default [class@Valent.Clipboard]. * - * Returns: (transfer none) (not nullable): a #ValentClipboard + * Returns: (transfer none) (not nullable): a `ValentClipboard` * * Since: 1.0 */ @@ -229,7 +229,7 @@ valent_clipboard_get_default (void) /** * valent_clipboard_get_mimetypes: - * @clipboard: a #ValentClipboard + * @clipboard: a `ValentClipboard` * * Get the mime-types of the primary clipboard content. * @@ -255,7 +255,7 @@ valent_clipboard_get_mimetypes (ValentClipboard *clipboard) /** * valent_clipboard_get_timestamp: - * @clipboard: a #ValentClipboard + * @clipboard: a `ValentClipboard` * * Get the timestamp of the current clipboard content, in milliseconds since the * UNIX epoch. @@ -281,10 +281,10 @@ valent_clipboard_get_timestamp (ValentClipboard *clipboard) /** * valent_clipboard_read_bytes: - * @clipboard: a #ValentClipboard + * @clipboard: a `ValentClipboard` * @mimetype: a mime-type - * @cancellable: (nullable): a #GCancellable - * @callback: (scope async): a #GAsyncReadyCallback + * @cancellable: (nullable): a `GCancellable` + * @callback: (scope async): a `GAsyncReadyCallback` * @user_data: (closure): user supplied data * * Get the content of the primary clipboard adapter. @@ -331,9 +331,9 @@ valent_clipboard_read_bytes (ValentClipboard *clipboard, /** * valent_clipboard_read_bytes_finish: - * @clipboard: a #ValentClipboard - * @result: a #GAsyncResult - * @error: (nullable): a #GError + * @clipboard: a `ValentClipboard` + * @result: a `GAsyncResult` + * @error: (nullable): a `GError` * * Finish an operation started by [method@Valent.Clipboard.read_bytes]. * @@ -361,11 +361,11 @@ valent_clipboard_read_bytes_finish (ValentClipboard *clipboard, /** * valent_clipboard_write_bytes: - * @clipboard: a #ValentClipboard + * @clipboard: a `ValentClipboard` * @mimetype: (nullable): a mime-type, or %NULL if @bytes is %NULL - * @bytes: (nullable): a #GBytes, or %NULL if @mimetype is %NULL - * @cancellable: (nullable): a #GCancellable - * @callback: (scope async): a #GAsyncReadyCallback + * @bytes: (nullable): a `GBytes`, or %NULL if @mimetype is %NULL + * @cancellable: (nullable): a `GCancellable` + * @callback: (scope async): a `GAsyncReadyCallback` * @user_data: (closure): user supplied data * * Set the content of the primary clipboard adapter. @@ -414,9 +414,9 @@ valent_clipboard_write_bytes (ValentClipboard *clipboard, /** * valent_clipboard_write_bytes_finish: - * @clipboard: a #ValentClipboard - * @result: a #GAsyncResult - * @error: (nullable): a #GError + * @clipboard: a `ValentClipboard` + * @result: a `GAsyncResult` + * @error: (nullable): a `GError` * * Finish an operation started by [method@Valent.Clipboard.write_bytes]. * @@ -444,9 +444,9 @@ valent_clipboard_write_bytes_finish (ValentClipboard *clipboard, /** * valent_clipboard_read_text: - * @clipboard: a #ValentClipboard - * @cancellable: (nullable): a #GCancellable - * @callback: (scope async): a #GAsyncReadyCallback + * @clipboard: a `ValentClipboard` + * @cancellable: (nullable): a `GCancellable` + * @callback: (scope async): a `GAsyncReadyCallback` * @user_data: (closure): user supplied data * * Get the text content of the primary clipboard adapter. @@ -516,9 +516,9 @@ valent_clipboard_read_text (ValentClipboard *clipboard, /** * valent_clipboard_read_text_finish: - * @clipboard: a #ValentClipboard - * @result: a #GAsyncResult - * @error: (nullable): a #GError + * @clipboard: a `ValentClipboard` + * @result: a `GAsyncResult` + * @error: (nullable): a `GError` * * Finish an operation started by [method@Valent.Clipboard.read_text]. * @@ -546,10 +546,10 @@ valent_clipboard_read_text_finish (ValentClipboard *clipboard, /** * valent_clipboard_write_text: - * @clipboard: a #ValentClipboard + * @clipboard: a `ValentClipboard` * @text: text content - * @cancellable: (nullable): a #GCancellable - * @callback: (scope async): a #GAsyncReadyCallback + * @cancellable: (nullable): a `GCancellable` + * @callback: (scope async): a `GAsyncReadyCallback` * @user_data: (closure): user supplied data * * Set the text content of the primary clipboard adapter. @@ -600,9 +600,9 @@ valent_clipboard_write_text (ValentClipboard *clipboard, /** * valent_clipboard_write_text_finish: - * @clipboard: a #ValentClipboard - * @result: a #GAsyncResult - * @error: (nullable): a #GError + * @clipboard: a `ValentClipboard` + * @result: a `GAsyncResult` + * @error: (nullable): a `GError` * * Finish an operation started by [method@Valent.Clipboard.write_text]. * diff --git a/src/libvalent/contacts/valent-contact-cache.c b/src/libvalent/contacts/valent-contact-cache.c index 594ef719fd..a790c0e42e 100644 --- a/src/libvalent/contacts/valent-contact-cache.c +++ b/src/libvalent/contacts/valent-contact-cache.c @@ -17,7 +17,7 @@ * * An implementation of [class@Valent.ContactStore]. * - * #ValentContactCache is a simple implementation of [class@Valent.ContactStore] + * `ValentContactCache` is a simple implementation of [class@Valent.ContactStore] * for local contact store, used as a fallback when Evolution Data Server is not * available. * diff --git a/src/libvalent/contacts/valent-contact-store.c b/src/libvalent/contacts/valent-contact-store.c index bbcde9a886..7ba043d891 100644 --- a/src/libvalent/contacts/valent-contact-store.c +++ b/src/libvalent/contacts/valent-contact-store.c @@ -16,7 +16,7 @@ * * An abstract base class for address books. * - * #ValentContactStore is a base class to provide an interface to an address + * `ValentContactStore` is a base class to provide an interface to an address * book. This usually means adding, removing and querying contacts. * * Since: 1.0 @@ -35,10 +35,10 @@ G_DEFINE_ABSTRACT_TYPE_WITH_PRIVATE (ValentContactStore, valent_contact_store, V * @get_contact: the virtual function pointer for valent_contact_store_get_contact() * @remove_contact: the virtual function pointer for valent_contact_store_remove_contact() * @query: the virtual function pointer for valent_contact_store_query() - * @contact_added: the class closure for #ValentContactStore::contact-added - * @contact_removed: the class closure for #ValentContactStore::contact-removed + * @contact_added: the class closure for `ValentContactStore`::contact-added + * @contact_removed: the class closure for `ValentContactStore`::contact-removed * - * The virtual function table for #ValentContactStore. + * The virtual function table for `ValentContactStore`. */ @@ -323,8 +323,8 @@ valent_contact_store_class_init (ValentContactStoreClass *klass) /** * ValentContactStore::contact-added: - * @store: a #ValentContactStore - * @contact: a #EContact + * @store: a `ValentContactStore` + * @contact: a `EContact` * * Emitted when an [class@EBookContacts.Contact] is added to @store. * @@ -346,7 +346,7 @@ valent_contact_store_class_init (ValentContactStoreClass *klass) /** * ValentContactStore::contact-removed: - * @store: a #ValentContactStore + * @store: a `ValentContactStore` * @uid: the UID of the removed contact * * Emitted when an [class@EBookContacts.Contact] is removed from @store. @@ -375,8 +375,8 @@ valent_contact_store_init (ValentContactStore *store) /** * valent_contact_store_contact_added: - * @store: a #ValentContactStore - * @contact: the #EContact + * @store: a `ValentContactStore` + * @contact: the `EContact` * * Emits [signal@Valent.ContactStore::contact-added] signal on @store. * @@ -412,7 +412,7 @@ valent_contact_store_contact_added (ValentContactStore *store, /** * valent_contact_store_contact_removed: - * @store: a #ValentContactStore + * @store: a `ValentContactStore` * @uid: the UID of @contact * * Emits [signal@Valent.ContactStore::contact-removed] on @store. @@ -449,7 +449,7 @@ valent_contact_store_contact_removed (ValentContactStore *store, /** * valent_contact_store_get_name: (get-property name) - * @store: a #ValentContactStore + * @store: a `ValentContactStore` * * Get the display name of @store. * @@ -469,7 +469,7 @@ valent_contact_store_get_name (ValentContactStore *store) /** * valent_contact_store_set_name: (set-property name) - * @store: a #ValentContactStore + * @store: a `ValentContactStore` * @name: a display name * * Set the display name of @store to @name. @@ -491,11 +491,11 @@ valent_contact_store_set_name (ValentContactStore *store, /** * valent_contact_store_get_source: (get-property source) - * @store: a #ValentContactStore + * @store: a `ValentContactStore` * - * Get the #ESource backing @store. + * Get the `ESource` backing @store. * - * Returns: (transfer none) (not nullable): an #ESource + * Returns: (transfer none) (not nullable): an `ESource` * * Since: 1.0 */ @@ -511,7 +511,7 @@ valent_contact_store_get_source (ValentContactStore *store) /** * valent_contact_store_get_uid: (get-property uid) - * @store: a #ValentContactStore + * @store: a `ValentContactStore` * * Get the UID of @store. * @@ -531,10 +531,10 @@ valent_contact_store_get_uid (ValentContactStore *store) /** * valent_contact_store_add_contact: - * @store: a #ValentContactStore - * @contact: a #EContact - * @cancellable: (nullable): #GCancellable - * @callback: (scope async): a #GAsyncReadyCallback + * @store: a `ValentContactStore` + * @contact: a `EContact` + * @cancellable: (nullable): `GCancellable` + * @callback: (scope async): a `GAsyncReadyCallback` * @user_data: (closure): user supplied data * * A convenience wrapper around [method@Valent.ContactStore.add_contacts] for @@ -571,10 +571,10 @@ valent_contact_store_add_contact (ValentContactStore *store, /** * valent_contact_store_add_contacts: (virtual add_contacts) - * @store: a #ValentContactStore - * @contacts: (element-type EContact): a #GSList - * @cancellable: (nullable): #GCancellable - * @callback: (scope async): a #GAsyncReadyCallback + * @store: a `ValentContactStore` + * @contacts: (element-type EContact): a `GSList` + * @cancellable: (nullable): `GCancellable` + * @callback: (scope async): a `GAsyncReadyCallback` * @user_data: (closure): user supplied data * * Add @contacts to @store. @@ -607,9 +607,9 @@ valent_contact_store_add_contacts (ValentContactStore *store, /** * valent_contact_store_add_contacts_finish: - * @store: a #ValentContactStore - * @result: a #GAsyncResult - * @error: (nullable): a #GError + * @store: a `ValentContactStore` + * @result: a `GAsyncResult` + * @error: (nullable): a `GError` * * Finish an operation started by [method@Valent.ContactStore.add_contact] or * [method@Valent.ContactStore.add_contacts]. @@ -638,10 +638,10 @@ valent_contact_store_add_contacts_finish (ValentContactStore *store, /** * valent_contact_store_remove_contact: - * @store: a #ValentContactStore + * @store: a `ValentContactStore` * @uid: a contact UID - * @cancellable: (nullable): #GCancellable - * @callback: (scope async): a #GAsyncReadyCallback + * @cancellable: (nullable): `GCancellable` + * @callback: (scope async): a `GAsyncReadyCallback` * @user_data: (closure): user supplied data * * Remove contact @uid from @store. @@ -680,10 +680,10 @@ valent_contact_store_remove_contact (ValentContactStore *store, /** * valent_contact_store_remove_contacts: (virtual remove_contacts) - * @store: a #ValentContactStore - * @uids: (element-type utf8): a #GSList of contact UIDs - * @cancellable: (nullable): #GCancellable - * @callback: (scope async): a #GAsyncReadyCallback + * @store: a `ValentContactStore` + * @uids: (element-type utf8): a `GSList` of contact UIDs + * @cancellable: (nullable): `GCancellable` + * @callback: (scope async): a `GAsyncReadyCallback` * @user_data: (closure): user supplied data * * Remove contact @uid from @store. @@ -716,9 +716,9 @@ valent_contact_store_remove_contacts (ValentContactStore *store, /** * valent_contact_store_remove_contacts_finish: - * @store: a #ValentContactStore - * @result: a #GAsyncResult - * @error: (nullable): a #GError + * @store: a `ValentContactStore` + * @result: a `GAsyncResult` + * @error: (nullable): a `GError` * * Finish an operation started by [method@Valent.ContactStore.remove_contact] or * [method@Valent.ContactStore.remove_contacts]. @@ -747,10 +747,10 @@ valent_contact_store_remove_contacts_finish (ValentContactStore *store, /** * valent_contact_store_query: (virtual query) - * @store: a #ValentContactStore + * @store: a `ValentContactStore` * @query: a search expression - * @cancellable: (nullable): #GCancellable - * @callback: (scope async): a #GAsyncReadyCallback + * @cancellable: (nullable): `GCancellable` + * @callback: (scope async): a `GAsyncReadyCallback` * @user_data: (closure): user supplied data * * Query @store for contacts matching @query. @@ -783,13 +783,13 @@ valent_contact_store_query (ValentContactStore *store, /** * valent_contact_store_query_finish: - * @store: a #ValentContactStore - * @result: a #GAsyncResult - * @error: (nullable): a #GError + * @store: a `ValentContactStore` + * @result: a `GAsyncResult` + * @error: (nullable): a `GError` * * Finish an operation started by [method@Valent.ContactStore.query]. * - * Returns: (transfer full) (element-type EContact): a #GSList + * Returns: (transfer full) (element-type EContact): a `GSList` * * Since: 1.0 */ @@ -813,10 +813,10 @@ valent_contact_store_query_finish (ValentContactStore *store, /** * valent_contact_store_get_contact: (virtual get_contact) - * @store: a #ValentContactStore + * @store: a `ValentContactStore` * @uid: a contact UID - * @cancellable: (nullable): #GCancellable - * @callback: (scope async): a #GAsyncReadyCallback + * @cancellable: (nullable): `GCancellable` + * @callback: (scope async): a `GAsyncReadyCallback` * @user_data: (closure): user supplied data * * Get a contact by UID. @@ -849,13 +849,13 @@ valent_contact_store_get_contact (ValentContactStore *store, /** * valent_contact_store_get_contact_finish: - * @store: a #ValentContactStore - * @result: a #GAsyncResult - * @error: (nullable): a #GError + * @store: a `ValentContactStore` + * @result: a `GAsyncResult` + * @error: (nullable): a `GError` * * Finish an operation started by valent_contact_store_get_contact(). * - * Returns: (transfer full) (nullable): a #EContact + * Returns: (transfer full) (nullable): a `EContact` * * Since: 1.0 */ @@ -879,10 +879,10 @@ valent_contact_store_get_contact_finish (ValentContactStore *store, /** * valent_contact_store_get_contacts: - * @store: a #ValentContactStore + * @store: a `ValentContactStore` * @uids: a list of UIDs - * @cancellable: (nullable): #GCancellable - * @callback: (scope async): a #GAsyncReadyCallback + * @cancellable: (nullable): `GCancellable` + * @callback: (scope async): a `GAsyncReadyCallback` * @user_data: (closure): user supplied data * * A convenience wrapper around [method@Valent.ContactStore.query] for searching diff --git a/src/libvalent/contacts/valent-contacts-adapter.c b/src/libvalent/contacts/valent-contacts-adapter.c index 2d1ecbf6c1..03f48418f2 100644 --- a/src/libvalent/contacts/valent-contacts-adapter.c +++ b/src/libvalent/contacts/valent-contacts-adapter.c @@ -17,7 +17,7 @@ * * An abstract base class for address book providers. * - * #ValentContactsAdapter is a base class for plugins that provide an + * `ValentContactsAdapter` is a base class for plugins that provide an * interface to manage address books. This usually means monitoring and * querying [class@Valent.ContactStore] instances. * @@ -47,7 +47,7 @@ G_DEFINE_ABSTRACT_TYPE_WITH_CODE (ValentContactsAdapter, valent_contacts_adapter /** * ValentContactsAdapterClass: * - * The virtual function table for #ValentContactsAdapter. + * The virtual function table for `ValentContactsAdapter`. */ @@ -126,8 +126,8 @@ valent_contacts_adapter_init (ValentContactsAdapter *adapter) /** * valent_contacts_adapter_store_added: - * @adapter: a #ValentContactsAdapter - * @store: a #ValentContactStore + * @adapter: a `ValentContactsAdapter` + * @store: a `ValentContactStore` * * Called when @store has been added to @adapter. * @@ -154,8 +154,8 @@ valent_contacts_adapter_store_added (ValentContactsAdapter *adapter, /** * valent_contacts_adapter_store_removed: - * @adapter: a #ValentContactsAdapter - * @store: a #ValentContactStore + * @adapter: a `ValentContactsAdapter` + * @store: a `ValentContactStore` * * Called when @store has been removed from @adapter. * diff --git a/src/libvalent/contacts/valent-contacts.c b/src/libvalent/contacts/valent-contacts.c index e234e4886e..0c1ac212a7 100644 --- a/src/libvalent/contacts/valent-contacts.c +++ b/src/libvalent/contacts/valent-contacts.c @@ -20,7 +20,7 @@ * * A class for managing address books. * - * #ValentContacts is an address book manager, intended for use by + * `ValentContacts` is an address book manager, intended for use by * [class@Valent.DevicePlugin] implementations. * * Plugins can implement [class@Valent.ContactsAdapter] to provide an interface @@ -246,7 +246,7 @@ valent_contacts_init (ValentContacts *self) * * Get the default [class@Valent.Contacts]. * - * Returns: (transfer none) (not nullable): a #ValentContacts + * Returns: (transfer none) (not nullable): a `ValentContacts` * * Since: 1.0 */ @@ -269,11 +269,11 @@ valent_contacts_get_default (void) /** * valent_contacts_ensure_store: - * @contacts: a #ValentContacts + * @contacts: a `ValentContacts` * @uid: a unique id * @name: a display name * - * Get a #ValentContactStore for @uid. + * Get a `ValentContactStore` for @uid. * * If the contact store does not exist, one will be created using the default * adapter and passed @name and @description. If no adapter is available, a new diff --git a/src/libvalent/core/valent-application-plugin.c b/src/libvalent/core/valent-application-plugin.c index fcb5b34dce..f3ccf077d1 100644 --- a/src/libvalent/core/valent-application-plugin.c +++ b/src/libvalent/core/valent-application-plugin.c @@ -17,7 +17,7 @@ * * An abstract base class for application plugins. * - * #ValentApplicationPlugin is a base class for plugins that operate in the + * `ValentApplicationPlugin` is a base class for plugins that operate in the * scope of the application. This usually means integrating the application with * the host environment (eg. XDG Autostart). * @@ -54,7 +54,7 @@ G_DEFINE_ABSTRACT_TYPE_WITH_PRIVATE (ValentApplicationPlugin, valent_application * @shutdown: the virtual function pointer for valent_application_plugin_shutdown() * @startup: the virtual function pointer for valent_application_plugin_startup() * - * The virtual function table for #ValentApplicationPlugin. + * The virtual function table for `ValentApplicationPlugin`. */ @@ -150,7 +150,7 @@ valent_application_plugin_init (ValentApplicationPlugin *adapter) /** * valent_application_plugin_activate: (virtual activate) - * @plugin: a #ValentApplicationPlugin + * @plugin: a `ValentApplicationPlugin` * * Handle activation of the application. * @@ -178,8 +178,8 @@ valent_application_plugin_activate (ValentApplicationPlugin *plugin) /** * valent_application_plugin_command_line: (virtual command_line) - * @plugin: a #ValentApplicationPlugin - * @command_line: a #GApplicationCommandLine + * @plugin: a `ValentApplicationPlugin` + * @command_line: a `GApplicationCommandLine` * * Handle the given command-line options. * @@ -210,7 +210,7 @@ valent_application_plugin_command_line (ValentApplicationPlugin *plugin, /** * valent_application_plugin_dbus_register: (virtual dbus_register) - * @plugin: a #ValentApplicationPlugin + * @plugin: a `ValentApplicationPlugin` * @connection: a `Gio.DBusCOnnection` * @object_path: a D-Bus object path * @error: (nullable): a `GError` @@ -253,7 +253,7 @@ valent_application_plugin_dbus_register (ValentApplicationPlugin *plugin, /** * valent_application_plugin_dbus_unregister: (virtual dbus_unregister) - * @plugin: a #ValentApplicationPlugin + * @plugin: a `ValentApplicationPlugin` * @connection: a `Gio.DBusCOnnection` * @object_path: a D * @@ -284,8 +284,8 @@ valent_application_plugin_dbus_unregister (ValentApplicationPlugin *plugin, /** * valent_application_plugin_open: (virtual open) - * @plugin: a #ValentApplicationPlugin - * @files: (array length=n_files): an array of #GFiles to open + * @plugin: a `ValentApplicationPlugin` + * @files: (array length=n_files): an array of `GFiles` to open * @n_files: the length of the @files array * @hint: (not nullable): a hint (or "") * @@ -324,7 +324,7 @@ valent_application_plugin_open (ValentApplicationPlugin *plugin, /** * valent_application_plugin_shutdown: (virtual shutdown) - * @plugin: a #ValentApplicationPlugin + * @plugin: a `ValentApplicationPlugin` * * Handle the shutdown phase of the application. * @@ -347,7 +347,7 @@ valent_application_plugin_shutdown (ValentApplicationPlugin *plugin) /** * valent_application_plugin_startup: (virtual startup) - * @plugin: a #ValentApplicationPlugin + * @plugin: a `ValentApplicationPlugin` * * Handle the startup phase of the application. * diff --git a/src/libvalent/core/valent-application.c b/src/libvalent/core/valent-application.c index f1720fd80c..325bb1df31 100644 --- a/src/libvalent/core/valent-application.c +++ b/src/libvalent/core/valent-application.c @@ -19,7 +19,7 @@ * * The primary application class of Valent. * - * #ValentApplication is the primary application class for Valent. + * `ValentApplication` is the primary application class for Valent. * * Since: 1.0 */ diff --git a/src/libvalent/core/valent-component.c b/src/libvalent/core/valent-component.c index d3054d9f08..30647420f6 100644 --- a/src/libvalent/core/valent-component.c +++ b/src/libvalent/core/valent-component.c @@ -21,7 +21,7 @@ * * An abstract base class for components. * - * #ValentComponent is a base class for session and system components, such as + * `ValentComponent` is a base class for session and system components, such as * the clipboard or volume control. Each component is typically used in a * singleton pattern, backed by one or more extensions. * @@ -47,7 +47,7 @@ G_DEFINE_ABSTRACT_TYPE_WITH_PRIVATE (ValentComponent, valent_component, VALENT_T * @bind_extension: the virtual function pointer for bind_extension() * @unbind_extension: the virtual function pointer for unbind_extension() * - * The virtual function table for #ValentComponent. + * The virtual function table for `ValentComponent`. */ enum { @@ -377,7 +377,7 @@ valent_component_real_unbind_extension (ValentComponent *component, /*< private > * valent_component_get_preferred: - * @self: a #ValentComponent + * @self: a `ValentComponent` * * Get the extension with the highest priority for @self. * diff --git a/src/libvalent/core/valent-context.c b/src/libvalent/core/valent-context.c index b5d4fff8ad..c5af460aba 100644 --- a/src/libvalent/core/valent-context.c +++ b/src/libvalent/core/valent-context.c @@ -19,7 +19,7 @@ * * A class representing a abstract data context. * - * #ValentContext is an abstraction of a data context, with a loose hierarchy + * `ValentContext` is an abstraction of a data context, with a loose hierarchy * expressed as a virtual path (e.g. `device/0123456789abcdef/plugin/battery`). * It can be used to coordinate persistent data of various types by mapping onto * existing hierarchies like [class@Gio.Settings] (i.e. relocatable schemas), @@ -47,7 +47,7 @@ G_DEFINE_TYPE_WITH_PRIVATE (ValentContext, valent_context, VALENT_TYPE_OBJECT) /** * ValentContextClass: * - * The virtual function table for #ValentContext. + * The virtual function table for `ValentContext`. */ enum { @@ -288,7 +288,7 @@ valent_context_init (ValentContext *self) * @domain: (nullable): a domain * @id: (nullable): a unique identifier * - * Create a new #ValentContext. + * Create a new `ValentContext`. * * If given, @parent will be taken into consideration when building paths. * @@ -298,7 +298,7 @@ valent_context_init (ValentContext *self) * If given, @id should be an identifier that is at least unique to @domain, * even if @domain is %NULL. * - * Returns: (transfer full): a new #ValentContext. + * Returns: (transfer full): a new `ValentContext`. * * Since: 1.0 */ @@ -316,7 +316,7 @@ valent_context_new (ValentContext *parent, /** * valent_context_get_domain: (get-property domain) - * @context: a #ValentContext + * @context: a `ValentContext` * * Get the context domain. * @@ -336,7 +336,7 @@ valent_context_get_domain (ValentContext *context) /** * valent_context_get_id: (get-property id) - * @context: a #ValentContext + * @context: a `ValentContext` * * Get the context ID. * @@ -356,11 +356,11 @@ valent_context_get_id (ValentContext *context) /** * valent_context_get_parent: (get-property parent) - * @context: a #ValentContext + * @context: a `ValentContext` * * Get the parent context. * - * Returns: (transfer none) (nullable): a #ValentContext + * Returns: (transfer none) (nullable): a `ValentContext` */ ValentContext * valent_context_get_parent (ValentContext *context) @@ -374,7 +374,7 @@ valent_context_get_parent (ValentContext *context) /** * valent_context_get_path: - * @context: a #ValentContext + * @context: a `ValentContext` * * Get the virtual path. * @@ -394,7 +394,7 @@ valent_context_get_path (ValentContext *context) /** * valent_context_clear_cache: - * @context: a #ValentContext + * @context: a `ValentContext` * * Clear cache data. * @@ -417,7 +417,7 @@ valent_context_clear_cache (ValentContext *context) /** * valent_context_clear: - * @context: a #ValentContext + * @context: a `ValentContext` * * Clear cache and configuration data. * @@ -450,7 +450,7 @@ valent_context_clear (ValentContext *context) /** * valent_context_get_cache_file: - * @context: a #ValentContext + * @context: a `ValentContext` * @filename: (type filename): a filename * * Create a new cache file. @@ -458,7 +458,7 @@ valent_context_clear (ValentContext *context) * This method creates a new [iface@Gio.File] for @filename in the cache * directory. * - * Returns: (transfer full) (nullable): a new #GFile + * Returns: (transfer full) (nullable): a new `GFile` * * Since: 1.0 */ @@ -477,7 +477,7 @@ valent_context_get_cache_file (ValentContext *context, /** * valent_context_get_config_file: - * @context: a #ValentContext + * @context: a `ValentContext` * @filename: (type filename): a filename * * Create a new config file. @@ -485,7 +485,7 @@ valent_context_get_cache_file (ValentContext *context, * This method creates a new [iface@Gio.File] for @filename in the config * directory. * - * Returns: (transfer full) (nullable): a new #GFile + * Returns: (transfer full) (nullable): a new `GFile` * * Since: 1.0 */ @@ -504,7 +504,7 @@ valent_context_get_config_file (ValentContext *context, /** * valent_context_get_data_file: - * @context: a #ValentContext + * @context: a `ValentContext` * @filename: (type filename): a filename * * Create a new data file. @@ -512,7 +512,7 @@ valent_context_get_config_file (ValentContext *context, * This method creates a new [iface@Gio.File] for @filename in the data * directory. * - * Returns: (transfer full) (nullable): a new #GFile + * Returns: (transfer full) (nullable): a new `GFile` * * Since: 1.0 */ @@ -531,10 +531,10 @@ valent_context_get_data_file (ValentContext *context, /** * valent_context_get_plugin_context: - * @context: a #ValentContext - * @plugin_info: a #PeasPluginInfo + * @context: a `ValentContext` + * @plugin_info: a `PeasPluginInfo` * - * Create a new #ValentContext for a plugin. + * Create a new `ValentContext` for a plugin. * * If given, @domain should be an identifier describing the scope of the * contexts that will share it. @@ -542,7 +542,7 @@ valent_context_get_data_file (ValentContext *context, * If given, @id should be an identifier that is at least unique to @domain, * even if @domain is %NULL. * - * Returns: (transfer full): a new #ValentContext. + * Returns: (transfer full): a new `ValentContext`. * * Since: 1.0 */ @@ -562,8 +562,8 @@ valent_context_get_plugin_context (ValentContext *context, /** * valent_context_get_plugin_settings: - * @context: a #ValentContext - * @plugin_info: a #PeasPluginInfo + * @context: a `ValentContext` + * @plugin_info: a `PeasPluginInfo` * @plugin_key: an external data key * * Create a [class@Gio.Settings] object for a plugin. @@ -670,7 +670,7 @@ valent_context_get_root (ValentContext *context) /** * valent_context_create_settings: - * @context: a #ValentContext + * @context: a `ValentContext` * @schema_id: a `GSettings` schema ID * * Create a [class@Gio.Settings] object. diff --git a/src/libvalent/core/valent-debug.h.in b/src/libvalent/core/valent-debug.h.in index 66c932e0c6..37dadceaa0 100644 --- a/src/libvalent/core/valent-debug.h.in +++ b/src/libvalent/core/valent-debug.h.in @@ -23,7 +23,7 @@ void valent_debug_clear (void); /** * VALENT_LOG_LEVEL_TRACE: (skip) * - * The #GLogLevelFlags log level for trace messages in Valent. + * The [flags@Glib.GLogLevelFlags] log level for trace messages in Valent. * * Since: 1.0 */ @@ -182,7 +182,7 @@ void valent_trace_mark (const char *strfunc, /** * VALENT_JSON: (skip) - * @_node: a #JsonNode + * @_node: a `JsonNode` * @_ctx: (type utf8): a prefix for context * * Logs @_node as pretty-printed JSON at %G_LOG_LEVEL_DEBUG, prefixed with diff --git a/src/libvalent/core/valent-extension.c b/src/libvalent/core/valent-extension.c index 1a84a18b87..866ea4f211 100644 --- a/src/libvalent/core/valent-extension.c +++ b/src/libvalent/core/valent-extension.c @@ -529,7 +529,7 @@ valent_extension_init (ValentExtension *self) * * Get the settings for this plugin. * - * Returns: (transfer none) (nullable): a #ValentContext + * Returns: (transfer none) (nullable): a `ValentContext` * * Since: 1.0 */ diff --git a/src/libvalent/core/valent-global.c b/src/libvalent/core/valent-global.c index e81d682c63..a1d9abbb2c 100644 --- a/src/libvalent/core/valent-global.c +++ b/src/libvalent/core/valent-global.c @@ -44,7 +44,7 @@ valent_init_ctor (void) * Use the macro `VALENT_IS_MAIN_THREAD()` to determine whether or not the code * is currently running on the main thread. * - * Returns: (transfer none): a #GThread + * Returns: (transfer none): a `GThread` * * Since: 1.0 */ @@ -57,14 +57,14 @@ valent_get_main_thread (void) /** * valent_get_plugin_engine: * - * Get the global #PeasEngine. + * Get the global `PeasEngine`. * - * The first call to this function initializes the #PeasEngine and adds + * The first call to this function initializes the `PeasEngine` and adds * `resource:///plugins` to the search path, where embedded plugins should be * registered. If running in a Flatpak, `/app/extensions/lib/valent/plugins` * will also be added to the search path for Flatpak extensions. * - * Returns: (transfer none): a #PeasEngine + * Returns: (transfer none): a `PeasEngine` * * Since: 1.0 */ @@ -126,7 +126,7 @@ valent_get_plugin_engine (void) /** * valent_get_user_directory: - * @directory: a #GUserDirectory + * @directory: a `GUserDirectory` * * Returns the full path of a special directory using its logical id. * @@ -167,7 +167,7 @@ valent_get_user_directory (GUserDirectory directory) * @basename exists in @dirname, the resulting file's name will have a * parenthesized number appended to it (e.g. `image.png (2)`). * - * Returns: (transfer full): a #GFile + * Returns: (transfer full): a `GFile` * * Since: 1.0 */ diff --git a/src/libvalent/core/valent-object.c b/src/libvalent/core/valent-object.c index 79eb07c804..81b8197e29 100644 --- a/src/libvalent/core/valent-object.c +++ b/src/libvalent/core/valent-object.c @@ -14,13 +14,13 @@ * * A base class for objects. * - * #ValentObject is a specialized #GObject class, based on GNOME Builder's + * `ValentObject` is a specialized `GObject` class, based on GNOME Builder's * `IdeObject`. It provides a simple base class with helpers for working in * threads. * - * Instances have a #GRecMutex and a #GCancellable that is created on demand by + * Instances have a `GRecMutex` and a `GCancellable` that is created on demand by * valent_object_ref_cancellable() is called. When the object is destroyed, the - * #GCancellable::cancel signal is emitted. + * `GCancellable`::cancel signal is emitted. * * Since: 1.0 */ @@ -258,7 +258,7 @@ valent_object_class_init (ValentObjectClass *klass) * * The object [class@Gio.Cancellable]. * - * A #GCancellable that can be used by operations that should be cancelled + * A `GCancellable` that can be used by operations that should be cancelled * when the object is destroyed (i.e. enters disposal). * * Since: 1.0 @@ -319,7 +319,7 @@ valent_object_init (ValentObject *self) /** * valent_object_lock: - * @object: a #ValentObject + * @object: a `ValentObject` * * Acquire a lock on @object. * @@ -339,7 +339,7 @@ valent_object_lock (ValentObject *object) /** * valent_object_unlock: - * @object: a #ValentObject + * @object: a `ValentObject` * * Release a lock on @object. * @@ -359,11 +359,11 @@ valent_object_unlock (ValentObject *object) /** * valent_object_ref_cancellable: - * @object: a #ValentObject + * @object: a `ValentObject` * * Get a [class@Gio.Cancellable] for the object. * - * Returns: (transfer full) (not nullable): @object's #GCancellable + * Returns: (transfer full) (not nullable): @object's `GCancellable` * * Since: 1.0 */ @@ -386,8 +386,8 @@ valent_object_ref_cancellable (ValentObject *object) /** * valent_object_chain_cancellable: - * @object: a #ValentObject - * @cancellable: (nullable): a #GCancellable + * @object: a `ValentObject` + * @cancellable: (nullable): a `GCancellable` * * Chain a cancellable to the object's cancellable. * @@ -401,7 +401,7 @@ valent_object_ref_cancellable (ValentObject *object) * asynchronous operation, to ensure it is cancelled if @cancellable is * triggered or @object is destroyed. * - * Returns: (transfer full) (not nullable): a #GCancellable + * Returns: (transfer full) (not nullable): a `GCancellable` * * Since: 1.0 */ @@ -439,7 +439,7 @@ valent_object_chain_cancellable (ValentObject *object, /** * valent_object_destroy: - * @object: a #ValentObject + * @object: a `ValentObject` * * Destroy the object. * @@ -482,7 +482,7 @@ valent_object_destroy (ValentObject *object) /** * valent_object_in_destruction: - * @object: a #ValentObject + * @object: a `ValentObject` * * Get whether the object is destroyed or in destruction. * @@ -507,7 +507,7 @@ valent_object_in_destruction (ValentObject *object) /** * valent_object_notify: - * @object: a #ValentObject + * @object: a `ValentObject` * @property_name: a property name * * Emit [signal@GObject.Object::notify] on @object, on the main thread. @@ -547,8 +547,8 @@ valent_object_notify (ValentObject *object, /** * valent_object_notify_by_pspec: - * @object: a #ValentObject - * @pspec: a #GParamSpec + * @object: a `ValentObject` + * @pspec: a `GParamSpec` * * Emit [signal@GObject.Object::notify] on @object, on the main thread. * diff --git a/src/libvalent/core/valent-transfer.c b/src/libvalent/core/valent-transfer.c index 4c91a59d34..694c6e1d56 100644 --- a/src/libvalent/core/valent-transfer.c +++ b/src/libvalent/core/valent-transfer.c @@ -19,7 +19,7 @@ * * An abstract base class for data transfers. * - * #ValentTransfer is a generic class for transfers. + * `ValentTransfer` is a generic class for transfers. * * Since: 1.0 */ @@ -236,7 +236,7 @@ valent_transfer_init (ValentTransfer *self) /** * valent_transfer_dup_id: (get-property id) - * @transfer: a #ValentTransfer + * @transfer: a `ValentTransfer` * * Get the transfer ID. * @@ -263,7 +263,7 @@ valent_transfer_dup_id (ValentTransfer *transfer) /** * valent_transfer_get_progress: (get-property progress) - * @transfer: a #ValentTransfer + * @transfer: a `ValentTransfer` * * Get the transfer progress. * @@ -288,7 +288,7 @@ valent_transfer_get_progress (ValentTransfer *transfer) /** * valent_transfer_set_progress: (set-property progress) - * @transfer: a #ValentTransfer + * @transfer: a `ValentTransfer` * @progress: a number from `0.0` to `1.0` * * Set the transfer progress. @@ -319,11 +319,11 @@ valent_transfer_set_progress (ValentTransfer *transfer, /** * valent_transfer_get_state: (get-property state) - * @transfer: a #ValentTransfer + * @transfer: a `ValentTransfer` * * Get the transfer state. * - * Returns: a #ValentTransferState + * Returns: a `ValentTransferState` * * Since: 1.0 */ @@ -382,9 +382,9 @@ valent_transfer_execute_cb (GObject *object, /** * valent_transfer_execute: (virtual execute) - * @transfer: a #ValentTransfer - * @cancellable: (nullable): a #GCancellable - * @callback: (scope async): a #GAsyncReadyCallback + * @transfer: a `ValentTransfer` + * @cancellable: (nullable): a `GCancellable` + * @callback: (scope async): a `GAsyncReadyCallback` * @user_data: (closure): user supplied data * * Start the transfer operation. @@ -445,9 +445,9 @@ valent_transfer_execute (ValentTransfer *transfer, /** * valent_transfer_execute_finish: (virtual execute_finish) - * @transfer: a #ValentTransfer - * @result: a #GAsyncResult - * @error: (nullable): a #GError + * @transfer: a `ValentTransfer` + * @result: a `GAsyncResult` + * @error: (nullable): a `GError` * * Finish an operation started by [method@Valent.Transfer.execute]. * @@ -477,7 +477,7 @@ valent_transfer_execute_finish (ValentTransfer *transfer, /** * valent_transfer_cancel: - * @transfer: a #ValentTransfer + * @transfer: a `ValentTransfer` * * Cancel the transfer operation. * @@ -503,8 +503,8 @@ valent_transfer_cancel (ValentTransfer *transfer) /** * valent_transfer_check_status: - * @transfer: a #ValentTransfer - * @error: (nullable): a #GError + * @transfer: a `ValentTransfer` + * @error: (nullable): a `GError` * * Check the transfer status. * diff --git a/src/libvalent/device/valent-certificate.c b/src/libvalent/device/valent-certificate.c index 08c89e053e..04b9160cdd 100644 --- a/src/libvalent/device/valent-certificate.c +++ b/src/libvalent/device/valent-certificate.c @@ -27,7 +27,7 @@ * @cert_path: (type filename): file path to the certificate * @key_path: (type filename): file path to the private key * @common_name: common name for the certificate - * @error: (nullable): a #GError + * @error: (nullable): a `GError` * * Generate a private key and certificate for @common_name, saving them at * @key_path and @cert_path respectively. @@ -178,8 +178,8 @@ valent_certificate_new_task (GTask *task, /** * valent_certificate_new: * @path: (type filename): a directory path - * @cancellable: (nullable): #GCancellable - * @callback: (scope async): a #GAsyncReadyCallback + * @cancellable: (nullable): `GCancellable` + * @callback: (scope async): a `GAsyncReadyCallback` * @user_data: (closure): user supplied data * * Get a TLS certificate and private key pair. @@ -214,15 +214,15 @@ valent_certificate_new (const char *path, /** * valent_certificate_new_finish: - * @result: a #GAsyncResult provided to callback - * @error: (nullable): a #GError + * @result: a `GAsyncResult` provided to callback + * @error: (nullable): a `GError` * * Finish an operation started by [func@Valent.certificate_new]. * * If either generating or loading the certificate failed, %NULL will be * returned with @error set. * - * Returns: (transfer full) (nullable): a #GTlsCertificate + * Returns: (transfer full) (nullable): a `GTlsCertificate` * * Since: 1.0 */ @@ -238,7 +238,7 @@ valent_certificate_new_finish (GAsyncResult *result, /** * valent_certificate_new_sync: * @path: (type filename): a directory path - * @error: (nullable): a #GError + * @error: (nullable): a `GError` * * Get a TLS certificate and private key pair. * @@ -252,7 +252,7 @@ valent_certificate_new_finish (GAsyncResult *result, * If either generating or loading the certificate fails, %NULL will be returned * with @error set. * - * Returns: (transfer full) (nullable): a #GTlsCertificate + * Returns: (transfer full) (nullable): a `GTlsCertificate` * * Since: 1.0 */ @@ -285,7 +285,7 @@ valent_certificate_new_sync (const char *path, /** * valent_certificate_get_common_name: - * @certificate: a #GTlsCertificate + * @certificate: a `GTlsCertificate` * * Get the common name from @certificate, which by convention in KDE Connect is * the single source of truth for a device's ID. @@ -347,7 +347,7 @@ valent_certificate_get_common_name (GTlsCertificate *certificate) /** * valent_certificate_get_fingerprint: - * @certificate: a #GTlsCertificate + * @certificate: a `GTlsCertificate` * * Get a SHA256 fingerprint hash of @certificate. * @@ -399,7 +399,7 @@ valent_certificate_get_fingerprint (GTlsCertificate *certificate) /** * valent_certificate_get_public_key: - * @certificate: a #GTlsCertificate + * @certificate: a `GTlsCertificate` * * Get the public key of @certificate. * diff --git a/src/libvalent/device/valent-channel-service.c b/src/libvalent/device/valent-channel-service.c index ac370a4255..465a5a04d9 100644 --- a/src/libvalent/device/valent-channel-service.c +++ b/src/libvalent/device/valent-channel-service.c @@ -21,7 +21,7 @@ * * An abstract base class for connection backends. * - * #ValentChannelService is a base class for plugins that implement an interface + * `ValentChannelService` is a base class for plugins that implement an interface * to negotiate connections with other devices. * * ## Implementation Notes @@ -50,9 +50,9 @@ G_DEFINE_ABSTRACT_TYPE_WITH_PRIVATE (ValentChannelService, valent_channel_servic * ValentChannelServiceClass: * @build_identity: the virtual function pointer for valent_channel_service_build_identity() * @identify: the virtual function pointer for valent_channel_service_identify() - * @channel: the class closure for #ValentChannelService::channel + * @channel: the class closure for `ValentChannelService`::channel * - * The virtual function table for #ValentChannelService. + * The virtual function table for `ValentChannelService`. */ enum { @@ -196,9 +196,9 @@ get_chassis_type (void) /** * collect_capabilities: - * @info: a #PeasPluginInfo - * @incoming: a #GHashTable - * @outgoing: a #GHashTable + * @info: a `PeasPluginInfo` + * @incoming: a `GHashTable` + * @outgoing: a `GHashTable` * * Collect the capabilities from @info and add them to @incoming and @outgoing, * using g_hash_table_add() to coalesce duplicates. @@ -515,8 +515,8 @@ valent_channel_service_class_init (ValentChannelServiceClass *klass) /** * ValentChannelService::channel: - * @service: a #ValentChannelService - * @channel: a #ValentChannel + * @service: a `ValentChannelService` + * @channel: a `ValentChannel` * * Emitted when a new channel has been negotiated. * @@ -568,7 +568,7 @@ valent_channel_service_ref_certificate (ValentChannelService *service) /** * valent_channel_service_dup_id: (get-property id) - * @service: a #ValentChannelService + * @service: a `ValentChannelService` * * Get the local ID. * @@ -593,7 +593,7 @@ valent_channel_service_dup_id (ValentChannelService *service) /** * valent_channel_service_ref_identity: (get-property identity) - * @service: a #ValentChannelService + * @service: a `ValentChannelService` * * Get the local identity packet. * @@ -618,7 +618,7 @@ valent_channel_service_ref_identity (ValentChannelService *service) /** * valent_channel_service_get_name: (get-property name) - * @service: a #ValentChannelService + * @service: a `ValentChannelService` * * Get the local display name. * @@ -638,7 +638,7 @@ valent_channel_service_get_name (ValentChannelService *service) /** * valent_channel_service_set_name: (set-property name) - * @service: a #ValentChannelService + * @service: a `ValentChannelService` * @name: (not nullable): a display name * * Set the local display name. @@ -670,7 +670,7 @@ valent_channel_service_set_name (ValentChannelService *service, /** * valent_channel_service_build_identity: (virtual build_identity) - * @service: a #ValentChannelService + * @service: a `ValentChannelService` * * Rebuild the local KDE Connect identity packet. * @@ -699,7 +699,7 @@ valent_channel_service_build_identity (ValentChannelService *service) /** * valent_channel_service_identify: (virtual identify) - * @service: a #ValentChannelService + * @service: a `ValentChannelService` * @target: (nullable): a target string * * Identify the host device to the network. @@ -727,8 +727,8 @@ valent_channel_service_identify (ValentChannelService *service, /** * valent_channel_service_channel: - * @service: a #ValentChannelService - * @channel: a #ValentChannel + * @service: a `ValentChannelService` + * @channel: a `ValentChannel` * * Emit [signal@Valent.ChannelService::channel] on @service. * diff --git a/src/libvalent/device/valent-channel.c b/src/libvalent/device/valent-channel.c index 81dbfd7d1e..d5ecc11bba 100644 --- a/src/libvalent/device/valent-channel.c +++ b/src/libvalent/device/valent-channel.c @@ -20,7 +20,7 @@ * * A base class for device connections. * - * #ValentChannel is a base class for the primary communication channel in + * `ValentChannel` is a base class for the primary communication channel in * Valent. It is effectively an abstraction layer around a [class@Gio.IOStream]. * * ## Packet Exchange @@ -66,7 +66,7 @@ G_DEFINE_TYPE_WITH_PRIVATE (ValentChannel, valent_channel, VALENT_TYPE_OBJECT) * @upload: the virtual function pointer for valent_channel_upload() * @store_data: the virtual function pointer for valent_channel_store_data() * - * The virtual function table for #ValentChannel. + * The virtual function table for `ValentChannel`. */ enum { @@ -489,7 +489,7 @@ valent_channel_init (ValentChannel *self) /** * valent_channel_ref_base_stream: (get-property base-stream) - * @channel: a #ValentChannel + * @channel: a `ValentChannel` * * Get the base [class@Gio.IOStream]. * @@ -515,7 +515,7 @@ valent_channel_ref_base_stream (ValentChannel *channel) /** * valent_channel_get_identity: (get-property identity) - * @channel: A #ValentChannel + * @channel: A `ValentChannel` * * Get the local identity packet. * @@ -535,7 +535,7 @@ valent_channel_get_identity (ValentChannel *channel) /** * valent_channel_get_peer_identity: (get-property peer-identity) - * @channel: A #ValentChannel + * @channel: A `ValentChannel` * * Get the peer identity packet. * @@ -555,7 +555,7 @@ valent_channel_get_peer_identity (ValentChannel *channel) /** * valent_channel_get_verification_key: (virtual get_verification_key) - * @channel: a #ValentChannel + * @channel: a `ValentChannel` * * Get a verification key for the connection. * @@ -582,9 +582,9 @@ valent_channel_get_verification_key (ValentChannel *channel) /** * valent_channel_close: - * @channel: a #ValentChannel - * @cancellable: (nullable): a #GCancellable - * @error: (nullable): a #GError + * @channel: a `ValentChannel` + * @cancellable: (nullable): a `GCancellable` + * @error: (nullable): a `GError` * * Close the channel. * @@ -639,9 +639,9 @@ valent_channel_close_task (GTask *task, /** * valent_channel_close_async: - * @channel: a #ValentChannel - * @cancellable: (nullable): a #GCancellable - * @callback: (scope async): a #GAsyncReadyCallback + * @channel: a `ValentChannel` + * @cancellable: (nullable): a `GCancellable` + * @callback: (scope async): a `GAsyncReadyCallback` * @user_data: (closure): user supplied data * * Close the channel asynchronously. @@ -672,9 +672,9 @@ valent_channel_close_async (ValentChannel *channel, /** * valent_channel_close_finish: - * @channel: a #ValentChannel - * @result: a #GAsyncResult - * @error: (nullable): a #GError + * @channel: a `ValentChannel` + * @result: a `GAsyncResult` + * @error: (nullable): a `GError` * * Finish an operation started by [method@Valent.Channel.close_async]. * @@ -738,9 +738,9 @@ valent_channel_read_packet_task (GTask *task, /** * valent_channel_read_packet: - * @channel: a #ValentChannel - * @cancellable: (nullable): a #GCancellable - * @callback: (scope async): a #GAsyncReadyCallback + * @channel: a `ValentChannel` + * @cancellable: (nullable): a `GCancellable` + * @callback: (scope async): a `GAsyncReadyCallback` * @user_data: (closure): user supplied data * * Read the next KDE Connect packet from @channel. @@ -771,9 +771,9 @@ valent_channel_read_packet (ValentChannel *channel, /** * valent_channel_read_packet_finish: - * @channel: a #ValentChannel - * @result: a #GAsyncResult - * @error: (nullable): a #GError + * @channel: a `ValentChannel` + * @result: a `GAsyncResult` + * @error: (nullable): a `GError` * * Finish an operation started by [method@Valent.Channel.read_packet]. * @@ -832,10 +832,10 @@ valent_channel_write_packet_func (gpointer data) /** * valent_channel_write_packet: - * @channel: a #ValentChannel + * @channel: a `ValentChannel` * @packet: a KDE Connect packet - * @cancellable: (nullable): a #GCancellable - * @callback: (scope async): a #GAsyncReadyCallback + * @cancellable: (nullable): a `GCancellable` + * @callback: (scope async): a `GAsyncReadyCallback` * @user_data: (closure): user supplied data * * Send a packet over the channel. @@ -885,9 +885,9 @@ valent_channel_write_packet (ValentChannel *channel, /** * valent_channel_write_packet_finish: - * @channel: a #ValentChannel - * @result: a #GAsyncResult - * @error: (nullable): a #GError + * @channel: a `ValentChannel` + * @result: a `GAsyncResult` + * @error: (nullable): a `GError` * * Finish an operation started by [method@Valent.Channel.write_packet]. * @@ -915,8 +915,8 @@ valent_channel_write_packet_finish (ValentChannel *channel, /** * valent_channel_store_data: (virtual store_data) - * @channel: a #ValentChannel - * @context: a #ValentContext + * @channel: a `ValentChannel` + * @context: a `ValentContext` * * Store channel metadata. * @@ -944,10 +944,10 @@ valent_channel_store_data (ValentChannel *channel, /** * valent_channel_download: (virtual download) - * @channel: a #ValentChannel + * @channel: a `ValentChannel` * @packet: a KDE Connect packet - * @cancellable: (nullable): a #GCancellable - * @error: (nullable): a #GError + * @cancellable: (nullable): a `GCancellable` + * @error: (nullable): a `GError` * * Open an auxiliary connection, usually to download data. * @@ -959,7 +959,7 @@ valent_channel_store_data (ValentChannel *channel, * `payloadTransferInfo` dictionary on the same host as the channel. When the * connection is accepted the caller can perform operations on it as required. * - * Returns: (transfer full) (nullable): a #GIOStream + * Returns: (transfer full) (nullable): a `GIOStream` * * Since: 1.0 */ @@ -988,10 +988,10 @@ valent_channel_download (ValentChannel *channel, /** * valent_channel_download_async: (virtual download_async) - * @channel: a #ValentChannel + * @channel: a `ValentChannel` * @packet: a KDE Connect packet - * @cancellable: (nullable): a #GCancellable - * @callback: (scope async): a #GAsyncReadyCallback + * @cancellable: (nullable): a `GCancellable` + * @callback: (scope async): a `GAsyncReadyCallback` * @user_data: (closure): user supplied data * * Open an auxiliary connection, usually to download data. @@ -1028,13 +1028,13 @@ valent_channel_download_async (ValentChannel *channel, /** * valent_channel_download_finish: (virtual download_finish) - * @channel: a #ValentChannel - * @result: a #GAsyncResult - * @error: (nullable): a #GError + * @channel: a `ValentChannel` + * @result: a `GAsyncResult` + * @error: (nullable): a `GError` * * Finish an operation started with [method@Valent.Channel.download_async]. * - * Returns: (transfer full) (nullable): a #GIOStream + * Returns: (transfer full) (nullable): a `GIOStream` * * Since: 1.0 */ @@ -1060,10 +1060,10 @@ valent_channel_download_finish (ValentChannel *channel, /** * valent_channel_upload: (virtual upload) - * @channel: a #ValentChannel + * @channel: a `ValentChannel` * @packet: a KDE Connect packet - * @cancellable: (nullable): a #GCancellable - * @error: (nullable): a #GError + * @cancellable: (nullable): a `GCancellable` + * @error: (nullable): a `GError` * * Accept an auxiliary connection, usually to upload data. * @@ -1076,7 +1076,7 @@ valent_channel_download_finish (ValentChannel *channel, * send the packet with that port in the `payloadTransferInfo` dictionary. When * a connection is accepted the caller can perform operations on it as required. * - * Returns: (transfer full) (nullable): a #GIOStream + * Returns: (transfer full) (nullable): a `GIOStream` * * Since: 1.0 */ @@ -1105,10 +1105,10 @@ valent_channel_upload (ValentChannel *channel, /** * valent_channel_upload_async: (virtual upload_async) - * @channel: a #ValentChannel + * @channel: a `ValentChannel` * @packet: a KDE Connect packet - * @cancellable: (nullable): a #GCancellable - * @callback: (scope async): a #GAsyncReadyCallback + * @cancellable: (nullable): a `GCancellable` + * @callback: (scope async): a `GAsyncReadyCallback` * @user_data: (closure): user supplied data * * Accept an auxiliary connection, usually to upload data. @@ -1145,13 +1145,13 @@ valent_channel_upload_async (ValentChannel *channel, /** * valent_channel_upload_finish: (virtual upload_finish) - * @channel: a #ValentChannel - * @result: a #GAsyncResult - * @error: (nullable): a #GError + * @channel: a `ValentChannel` + * @result: a `GAsyncResult` + * @error: (nullable): a `GError` * * Finish an operation started with [method@Valent.Channel.upload_async]. * - * Returns: (transfer full) (nullable): a #GIOStream + * Returns: (transfer full) (nullable): a `GIOStream` * * Since: 1.0 */ diff --git a/src/libvalent/device/valent-device-impl.c b/src/libvalent/device/valent-device-impl.c index e7c0cf19bf..5324a214ec 100644 --- a/src/libvalent/device/valent-device-impl.c +++ b/src/libvalent/device/valent-device-impl.c @@ -433,11 +433,11 @@ valent_device_impl_init (ValentDeviceImpl *self) /** * valent_device_impl_new: - * @device: a #ValentDevice + * @device: a `ValentDevice` * - * Create a new #ValentDeviceImpl. + * Create a new `ValentDeviceImpl`. * - * Returns: (transfer full): a #GDBusInterfaceSkeleton + * Returns: (transfer full): a `GDBusInterfaceSkeleton` */ GDBusInterfaceSkeleton * valent_device_impl_new (ValentDevice *device) diff --git a/src/libvalent/device/valent-device-manager.c b/src/libvalent/device/valent-device-manager.c index 80feb944ad..d5a3c2b7da 100644 --- a/src/libvalent/device/valent-device-manager.c +++ b/src/libvalent/device/valent-device-manager.c @@ -26,7 +26,7 @@ * * A class for discovering and managing devices. * - * #ValentDeviceManager manages the available [class@Valent.Device] objects, + * `ValentDeviceManager` manages the available [class@Valent.Device] objects, * connecting them when [signal@Valent.ChannelService::channel] is emitted by an * enabled implementation, exporting them on D-Bus and removing them when they * become unavailable. @@ -1011,7 +1011,7 @@ valent_device_manager_init (ValentDeviceManager *self) * * Get the default [class@Valent.DeviceManager]. * - * Returns: (transfer none) (not nullable): a #ValentDeviceManager + * Returns: (transfer none) (not nullable): a `ValentDeviceManager` * * Since: 1.0 */ @@ -1026,7 +1026,7 @@ valent_device_manager_get_default (void) /** * valent_device_manager_get_name: (get-property name) - * @manager: a #ValentDeviceManager + * @manager: a `ValentDeviceManager` * * Get the display name of the local device. * @@ -1044,7 +1044,7 @@ valent_device_manager_get_name (ValentDeviceManager *manager) /** * valent_device_manager_set_name: (set-property name) - * @manager: a #ValentDeviceManager + * @manager: a `ValentDeviceManager` * @name: (not nullable): a display name * * Set the display name of the local device to @name. @@ -1064,7 +1064,7 @@ valent_device_manager_set_name (ValentDeviceManager *manager, /** * valent_device_manager_refresh: - * @manager: a #ValentDeviceManager + * @manager: a `ValentDeviceManager` * * Refresh the available devices. * diff --git a/src/libvalent/device/valent-device-plugin.c b/src/libvalent/device/valent-device-plugin.c index 53dd65c759..c061a58076 100644 --- a/src/libvalent/device/valent-device-plugin.c +++ b/src/libvalent/device/valent-device-plugin.c @@ -198,7 +198,7 @@ valent_device_plugin_queue_packet (ValentDevicePlugin *plugin, * valent_device_plugin_show_notification: * @plugin: a `ValentDevicePlugin` * @id: an id for the notification - * @notification: a #GNotification + * @notification: a `GNotification` * * A convenience for showing a local notification. * @@ -311,7 +311,7 @@ valent_device_plugin_handle_packet (ValentDevicePlugin *plugin, /** * valent_device_plugin_update_state: (virtual update_state) * @plugin: a `ValentDevicePlugin` - * @state: a #ValentDeviceState + * @state: a `ValentDeviceState` * * Update the plugin based on the new state of the device. * @@ -448,8 +448,8 @@ valent_device_plugin_set_menu_item (ValentDevicePlugin *plugin, /** * valent_notification_set_device_action: - * @notification: a #GNotification - * @device: a #ValentDevice + * @notification: a `GNotification` + * @device: a `ValentDevice` * @action: the device action name * @target: (nullable): the action target * @@ -486,8 +486,8 @@ valent_notification_set_device_action (GNotification *notification, /** * valent_notification_add_device_button: - * @notification: a #GNotification - * @device: a #ValentDevice + * @notification: a `GNotification` + * @device: a `ValentDevice` * @label: the button label * @action: the device action name * @target: (nullable): the action target diff --git a/src/libvalent/device/valent-device-transfer.c b/src/libvalent/device/valent-device-transfer.c index f1cc6951e6..e744b16257 100644 --- a/src/libvalent/device/valent-device-transfer.c +++ b/src/libvalent/device/valent-device-transfer.c @@ -20,7 +20,7 @@ * * A class for device file transfers. * - * #ValentDeviceTransfer is an implementation of [class@Valent.Transfer] for the + * `ValentDeviceTransfer` is an implementation of [class@Valent.Transfer] for the * common case of transferring a file between devices. * * The direction of the transfer is automatically detected from the content of @@ -446,13 +446,13 @@ valent_device_transfer_init (ValentDeviceTransfer *self) /** * valent_device_transfer_new: - * @device: a #ValentDevice + * @device: a `ValentDevice` * @packet: a KDE Connect packet - * @file: a #GFile + * @file: a `GFile` * * A convenience for creating a simple file transfer. * - * Returns: (transfer full) (nullable): a #ValentDeviceTransfer + * Returns: (transfer full) (nullable): a `ValentDeviceTransfer` * * Since: 1.0 */ @@ -474,11 +474,11 @@ valent_device_transfer_new (ValentDevice *device, /** * valent_device_transfer_ref_device: (get-property device) - * @transfer: a #ValentDeviceTransfer + * @transfer: a `ValentDeviceTransfer` * * Get the [class@Valent.Device]. * - * Returns: (transfer full) (nullable): a #ValentDevice + * Returns: (transfer full) (nullable): a `ValentDevice` * * Since: 1.0 */ @@ -499,11 +499,11 @@ valent_device_transfer_ref_device (ValentDeviceTransfer *transfer) /** * valent_device_transfer_ref_file: (get-property file) - * @transfer: a #ValentDeviceTransfer + * @transfer: a `ValentDeviceTransfer` * * Get the local [iface@Gio.File]. * - * Returns: (transfer full) (nullable): a #GFile + * Returns: (transfer full) (nullable): a `GFile` * * Since: 1.0 */ @@ -524,7 +524,7 @@ valent_device_transfer_ref_file (ValentDeviceTransfer *transfer) /** * valent_device_transfer_ref_packet: (get-property packet) - * @transfer: a #ValentDeviceTransfer + * @transfer: a `ValentDeviceTransfer` * * Get the KDE Connect packet. * diff --git a/src/libvalent/device/valent-device.c b/src/libvalent/device/valent-device.c index bea0ff4b8f..33be25d592 100644 --- a/src/libvalent/device/valent-device.c +++ b/src/libvalent/device/valent-device.c @@ -36,7 +36,7 @@ * Device functionality is limited to pairing and sending packets, while other * functionality is delegated to [class@Valent.DevicePlugin] extensions. * - * #ValentDevice implements the [iface@Gio.ActionGroup] interface, acting as an + * `ValentDevice` implements the [iface@Gio.ActionGroup] interface, acting as an * aggregate action group for plugins. Plugin actions are automatically included * in the device action group with the plugin module name as a prefix * (eg. `share.files`). @@ -1123,7 +1123,7 @@ valent_device_class_init (ValentDeviceClass *klass) * * Create a new device for @id. * - * Returns: (transfer full) (nullable): a new #ValentDevice + * Returns: (transfer full) (nullable): a new `ValentDevice` * * Since: 1.0 */ @@ -1140,11 +1140,11 @@ valent_device_new (const char *id) /*< private > * valent_device_new_full: * @identity: a KDE Connect identity packet - * @context: (nullable): a #ValentContext + * @context: (nullable): a `ValentContext` * * Create a new device for @identity. * - * Returns: (transfer full) (nullable): a new #ValentDevice + * Returns: (transfer full) (nullable): a new `ValentDevice` */ ValentDevice * valent_device_new_full (JsonNode *identity, @@ -1195,10 +1195,10 @@ valent_device_send_packet_cb (ValentChannel *channel, /** * valent_device_send_packet: - * @device: a #ValentDevice + * @device: a `ValentDevice` * @packet: a KDE Connect packet - * @cancellable: (nullable): a #GCancellable - * @callback: (scope async): a #GAsyncReadyCallback + * @cancellable: (nullable): a `GCancellable` + * @callback: (scope async): a `GAsyncReadyCallback` * @user_data: (closure): user supplied data * * Send a KDE Connect packet to the device. @@ -1264,9 +1264,9 @@ valent_device_send_packet (ValentDevice *device, /** * valent_device_send_packet_finish: - * @device: a #ValentDevice - * @result: a #GAsyncResult - * @error: (nullable): a #GError + * @device: a `ValentDevice` + * @result: a `GAsyncResult` + * @error: (nullable): a `GError` * * Finish an operation started by [method@Valent.Device.send_packet]. * @@ -1288,11 +1288,11 @@ valent_device_send_packet_finish (ValentDevice *device, /** * valent_device_ref_channel: - * @device: a #ValentDevice + * @device: a `ValentDevice` * * Get the active channel. * - * Returns: (transfer full) (nullable): a #ValentChannel, or %NULL if disconnected + * Returns: (transfer full) (nullable): a `ValentChannel`, or %NULL if disconnected * * Since: 1.0 */ @@ -1351,8 +1351,8 @@ read_packet_cb (ValentChannel *channel, /** * valent_device_set_channel: - * @device: A #ValentDevice - * @channel: (nullable): A #ValentChannel + * @device: A `ValentDevice` + * @channel: (nullable): A `ValentChannel` * * Sets the active channel. * @@ -1413,11 +1413,11 @@ valent_device_set_channel (ValentDevice *device, /** * valent_device_get_context: (get-property context) - * @device: a #ValentDevice + * @device: a `ValentDevice` * * Get the data context. * - * Returns: (transfer full): a #ValentContext + * Returns: (transfer full): a `ValentContext` * * Since: 1.0 */ @@ -1431,7 +1431,7 @@ valent_device_get_context (ValentDevice *device) /** * valent_device_get_icon_name: (get-property icon-name) - * @device: a #ValentDevice + * @device: a `ValentDevice` * * Get the symbolic icon name. * @@ -1449,7 +1449,7 @@ valent_device_get_icon_name (ValentDevice *device) /** * valent_device_get_id: (get-property id) - * @device: a #ValentDevice + * @device: a `ValentDevice` * * Get the unique ID. * @@ -1468,14 +1468,14 @@ valent_device_get_id (ValentDevice *device) /** * valent_device_get_menu: - * @device: a #ValentDevice + * @device: a `ValentDevice` * * Get the [class@Gio.MenuModel] of the device. * * Plugins may add items and submenus to this when they want to expose actions * with presentation details like a label or icon. * - * Returns: (transfer none): a #GMenuModel + * Returns: (transfer none): a `GMenuModel` * * Since: 1.0 */ @@ -1489,7 +1489,7 @@ valent_device_get_menu (ValentDevice *device) /** * valent_device_get_name: - * @device: a #ValentDevice + * @device: a `ValentDevice` * * Get the display name of the device. * @@ -1507,7 +1507,7 @@ valent_device_get_name (ValentDevice *device) /** * valent_device_set_paired: - * @device: a #ValentDevice + * @device: a `ValentDevice` * @paired: %TRUE if paired, %FALSE if unpaired * * Set the paired state of the device. @@ -1549,7 +1549,7 @@ valent_device_set_paired (ValentDevice *device, /** * valent_device_get_plugins: (get-property plugins) - * @device: a #ValentDevice + * @device: a `ValentDevice` * * Get a list of the loaded plugins. * @@ -1577,11 +1577,11 @@ valent_device_get_plugins (ValentDevice *device) /** * valent_device_get_state: (get-property state) - * @device: a #ValentDevice + * @device: a `ValentDevice` * * Get the state of the device. * - * Returns: #ValentDeviceState flags describing the state of the device + * Returns: `ValentDeviceState` flags describing the state of the device * * Since: 1.0 */ @@ -1613,7 +1613,7 @@ valent_device_get_state (ValentDevice *device) /*< private > * valent_device_reload_plugins: - * @device: a #ValentDevice + * @device: a `ValentDevice` * * Reload all plugins. * @@ -1644,7 +1644,7 @@ valent_device_reload_plugins (ValentDevice *device) /*< private > * valent_device_update_plugins: - * @device: a #ValentDevice + * @device: a `ValentDevice` * * Update all plugins. * @@ -1675,8 +1675,8 @@ valent_device_update_plugins (ValentDevice *device) /*< private > * valent_device_supports_plugin: - * @device: a #ValentDevice - * @info: a #PeasPluginInfo + * @device: a `ValentDevice` + * @info: a `PeasPluginInfo` * * Check if @device supports the plugin described by @info. * diff --git a/src/libvalent/device/valent-packet.c b/src/libvalent/device/valent-packet.c index 33bfcd3db4..3b389d251f 100644 --- a/src/libvalent/device/valent-packet.c +++ b/src/libvalent/device/valent-packet.c @@ -181,7 +181,7 @@ valent_packet_get_type (JsonNode *packet) * * Convenience function for getting the packet body of a KDE Connect packet. * - * Returns: (transfer none) (nullable): a #JsonObject + * Returns: (transfer none) (nullable): a `JsonObject` * * Since: 1.0 */ @@ -242,7 +242,7 @@ valent_packet_has_payload (JsonNode *packet) * valent_packet_get_payload_full: * @packet: a KDE Connect packet * @size: (out) (nullable): the payload size - * @error: (nullable): a #GError + * @error: (nullable): a `GError` * * A convenience for retrieving the `payloadTransferInfo` and `payloadSize` * fields from @packet. @@ -251,7 +251,7 @@ valent_packet_has_payload (JsonNode *packet) * returned with @error set. See valent_packet_has_payload() for validation * criteria. * - * Returns: (transfer none) (nullable): a #JsonObject + * Returns: (transfer none) (nullable): a `JsonObject` * * Since: 1.0 */ @@ -301,7 +301,7 @@ valent_packet_get_payload_full (JsonNode *packet, /** * valent_packet_set_payload_full: * @packet: a KDE Connect packet - * @info: (transfer full): a #JsonObject + * @info: (transfer full): a `JsonObject` * @size: the payload size in bytes * * A convenience method for setting the `payloadTransferInfo` and `payloadSize` @@ -330,7 +330,7 @@ valent_packet_set_payload_full (JsonNode *packet, * * A convenience for retrieve the 'payloadTransferInfo` field from @packet. * - * Returns: (transfer none) (nullable): a #JsonObject + * Returns: (transfer none) (nullable): a `JsonObject` * * Since: 1.0 */ @@ -353,7 +353,7 @@ valent_packet_get_payload_info (JsonNode *packet) /** * valent_packet_set_payload_info: * @packet: a KDE Connect packet - * @info: (transfer full): a #JsonObject + * @info: (transfer full): a `JsonObject` * * A convenience method for setting the `payloadTransferInfo` field on @packet. * @@ -655,11 +655,11 @@ valent_packet_get_string (JsonNode *packet, * valent_packet_get_array: * @packet: a KDE Connect packet * @field: (not nullable): field name - * @value: (out) (nullable): a #JsonArray + * @value: (out) (nullable): a `JsonArray` * * Lookup @field in the body of @packet and assign it to @value. * - * If @field is not found or it is not a #JsonArray, %FALSE will be returned and + * If @field is not found or it is not a `JsonArray`, %FALSE will be returned and * @value will not be set. * * Returns: %TRUE, or %FALSE on failure @@ -699,11 +699,11 @@ valent_packet_get_array (JsonNode *packet, * valent_packet_get_object: * @packet: a KDE Connect packet * @field: (not nullable): field name - * @value: (out) (nullable): a #JsonObject + * @value: (out) (nullable): a `JsonObject` * * Lookup @field in the body of @packet and assign it to @value. * - * If @field is not found or it is not a #JsonObject, %FALSE will be returned + * If @field is not found or it is not a `JsonObject`, %FALSE will be returned * and @value will not be set. * * Returns: %TRUE, or %FALSE on failure @@ -747,7 +747,7 @@ valent_packet_get_object (JsonNode *packet, * Lookup @field in the body of @packet and return a newly allocated list of * strings. * - * If @field is not found, it is not a #JsonArray or any of its elements are not + * If @field is not found, it is not a `JsonArray` or any of its elements are not * strings, %NULL will be returned. * * Returns: (transfer full) (nullable) (array zero-terminated=1): a list of strings @@ -801,7 +801,7 @@ valent_packet_dup_strv (JsonNode *packet, /** * valent_packet_validate: * @packet: (nullable): a KDE Connect packet - * @error: (nullable): a #GError + * @error: (nullable): a `GError` * * Check if @packet is a well-formed KDE Connect packet. * @@ -901,10 +901,10 @@ valent_packet_validate (JsonNode *packet, /** * valent_packet_from_stream: - * @stream: a #GInputStream + * @stream: a `GInputStream` * @max_len: the maximum number bytes to read, or `-1` for no limit - * @cancellable: (nullable): a #GCancellable - * @error: (nullable): a #GError + * @cancellable: (nullable): a `GCancellable` + * @error: (nullable): a `GError` * * Read a KDE Connect packet from an input stream. * @@ -993,10 +993,10 @@ valent_packet_from_stream (GInputStream *stream, /** * valent_packet_to_stream: - * @stream: a #GOutputStream + * @stream: a `GOutputStream` * @packet: a KDE Connect packet - * @cancellable: (nullable): a #GCancellable - * @error: (nullable): a #GError + * @cancellable: (nullable): a `GCancellable` + * @error: (nullable): a `GError` * * A convenience function for writing a packet to a connection. * @@ -1088,7 +1088,7 @@ valent_packet_serialize (JsonNode *packet) /** * valent_packet_deserialize: * @json: a complete KDE Connect packet - * @error: (nullable): a #GError + * @error: (nullable): a `GError` * * Convenience function that deserializes a KDE Connect packet from a string * with basic validation. If @str is empty, this function will return %NULL. diff --git a/src/libvalent/device/valent-packet.h b/src/libvalent/device/valent-packet.h index e71c598658..c19643b110 100644 --- a/src/libvalent/device/valent-packet.h +++ b/src/libvalent/device/valent-packet.h @@ -43,7 +43,7 @@ GQuark valent_packet_error_quark (void); /** * valent_packet_is_valid: - * @packet: (nullable): a #JsonNode + * @packet: (nullable): a `JsonNode` * * Check if @packet is a well-formed KDE Connect packet. This can be used in * g_return_if_fail() checks. diff --git a/src/libvalent/input/valent-input-adapter.c b/src/libvalent/input/valent-input-adapter.c index 8529a39671..d4e8f63fa6 100644 --- a/src/libvalent/input/valent-input-adapter.c +++ b/src/libvalent/input/valent-input-adapter.c @@ -16,7 +16,7 @@ * * An abstract base class for virtual input devices. * - * #ValentInputAdapter is a base class for plugins that provide an interface to + * `ValentInputAdapter` is a base class for plugins that provide an interface to * the pointer and keyboard. This usually means simulating pointer and keyboard * events on the host system. * @@ -46,7 +46,7 @@ G_DEFINE_ABSTRACT_TYPE_WITH_PRIVATE (ValentInputAdapter, valent_input_adapter, V * @pointer_button: the virtual function pointer for valent_input_adapter_pointer_button() * @pointer_motion: the virtual function pointer for valent_input_adapter_pointer_motion() * - * The virtual function table for #ValentInputAdapter. + * The virtual function table for `ValentInputAdapter`. */ @@ -99,7 +99,7 @@ valent_input_adapter_init (ValentInputAdapter *adapter) /** * valent_input_adapter_keyboard_keysym: - * @adapter: a #ValentInputAdapter + * @adapter: a `ValentInputAdapter` * @keysym: a keysym * @state: %TRUE to press, or %FALSE to release * @@ -129,7 +129,7 @@ valent_input_adapter_keyboard_keysym (ValentInputAdapter *adapter, /** * valent_input_adapter_pointer_axis: - * @adapter: a #ValentInputAdapter + * @adapter: a `ValentInputAdapter` * @dx: movement on x-axis * @dy: movement on y-axis * @@ -160,7 +160,7 @@ valent_input_adapter_pointer_axis (ValentInputAdapter *adapter, /** * valent_input_adapter_pointer_button: - * @adapter: a #ValentInputAdapter + * @adapter: a `ValentInputAdapter` * @button: a button number * @state: %TRUE to press, or %FALSE to release * @@ -186,7 +186,7 @@ valent_input_adapter_pointer_button (ValentInputAdapter *adapter, /** * valent_input_adapter_pointer_motion: - * @adapter: a #ValentInputAdapter + * @adapter: a `ValentInputAdapter` * @dx: movement on x-axis * @dy: movement on y-axis * diff --git a/src/libvalent/input/valent-input.c b/src/libvalent/input/valent-input.c index 2e40c077be..0791c7041f 100644 --- a/src/libvalent/input/valent-input.c +++ b/src/libvalent/input/valent-input.c @@ -18,7 +18,7 @@ * * A class for controlling pointer and keyboard devices. * - * #ValentInput is an abstraction of virtual input devices, intended for use by + * `ValentInput` is an abstraction of virtual input devices, intended for use by * [class@Valent.DevicePlugin] implementations. * * Plugins can implement [class@Valent.InputAdapter] to provide an interface to @@ -220,7 +220,7 @@ valent_input_init (ValentInput *self) * * Get the default [class@Valent.Input]. * - * Returns: (transfer none) (not nullable): a #ValentInput + * Returns: (transfer none) (not nullable): a `ValentInput` * * Since: 1.0 */ @@ -243,8 +243,8 @@ valent_input_get_default (void) /** * valent_input_export_adapter: - * @input: a #ValentInput - * @adapter: a #ValentInputAdapter + * @input: a `ValentInput` + * @adapter: a `ValentInputAdapter` * * Export @adapter on all adapters that support it. * @@ -266,8 +266,8 @@ valent_input_export_adapter (ValentInput *input, /** * valent_input_unexport_adapter: - * @input: a #ValentInput - * @adapter: a #ValentInputAdapter + * @input: a `ValentInput` + * @adapter: a `ValentInputAdapter` * * Unexport @adapter from all adapters that support it. * @@ -299,7 +299,7 @@ valent_input_unexport_adapter (ValentInput *input, /** * valent_input_keyboard_keysym: - * @input: a #ValentInput + * @input: a `ValentInput` * @keysym: a keysym * @state: %TRUE to press, or %FALSE to release * @@ -324,7 +324,7 @@ valent_input_keyboard_keysym (ValentInput *input, /** * valent_input_pointer_axis: - * @input: a #ValentInput + * @input: a `ValentInput` * @dx: movement on x-axis * @dy: movement on y-axis * @@ -350,7 +350,7 @@ valent_input_pointer_axis (ValentInput *input, /** * valent_input_pointer_button: - * @input: a #ValentInput + * @input: a `ValentInput` * @button: a button * @state: %TRUE to press, or %FALSE to release * @@ -375,7 +375,7 @@ valent_input_pointer_button (ValentInput *input, /** * valent_input_pointer_motion: - * @input: a #ValentInput + * @input: a `ValentInput` * @dx: position on x-axis * @dy: position on y-axis * diff --git a/src/libvalent/media/valent-media-adapter.c b/src/libvalent/media/valent-media-adapter.c index c470c76fb1..30580a8f9b 100644 --- a/src/libvalent/media/valent-media-adapter.c +++ b/src/libvalent/media/valent-media-adapter.c @@ -16,7 +16,7 @@ * * An abstract base class for media player adapters. * - * #ValentMediaAdapter is a base class for plugins that provide an interface to + * `ValentMediaAdapter` is a base class for plugins that provide an interface to * manage media players. This usually means monitoring and querying instances of * [class@Valent.MediaPlayer]. * @@ -48,7 +48,7 @@ G_DEFINE_ABSTRACT_TYPE_WITH_CODE (ValentMediaAdapter, valent_media_adapter, VALE * @export_player: the virtual function pointer for valent_media_adapter_export() * @unexport_player: the virtual function pointer for valent_media_adapter_unexport() * - * The virtual function table for #ValentMediaAdapter. + * The virtual function table for `ValentMediaAdapter`. */ @@ -148,8 +148,8 @@ valent_media_adapter_init (ValentMediaAdapter *self) /** * valent_media_adapter_player_added: - * @adapter: a #ValentMediaAdapter - * @player: a #ValentMediaPlayer + * @adapter: a `ValentMediaAdapter` + * @player: a `ValentMediaPlayer` * * Called when @player has been added to @adapter. * @@ -176,8 +176,8 @@ valent_media_adapter_player_added (ValentMediaAdapter *adapter, /** * valent_media_adapter_player_removed: - * @adapter: a #ValentMediaAdapter - * @player: a #ValentMediaPlayer + * @adapter: a `ValentMediaAdapter` + * @player: a `ValentMediaPlayer` * * Called when @player has been removed from @adapter. * @@ -212,8 +212,8 @@ valent_media_adapter_player_removed (ValentMediaAdapter *adapter, /** * valent_media_adapter_export_player: (virtual export_player) - * @adapter: an #ValentMediaAdapter - * @player: a #ValentMediaPlayer + * @adapter: an `ValentMediaAdapter` + * @player: a `ValentMediaPlayer` * * Export @player on @adapter. * @@ -241,8 +241,8 @@ valent_media_adapter_export_player (ValentMediaAdapter *adapter, /** * valent_media_adapter_unexport_player: (virtual unexport_player) - * @adapter: an #ValentMediaAdapter - * @player: a #ValentMediaPlayer + * @adapter: an `ValentMediaAdapter` + * @player: a `ValentMediaPlayer` * * Unexport @player from @adapter. * diff --git a/src/libvalent/media/valent-media-player.c b/src/libvalent/media/valent-media-player.c index a6bcf2b70a..69bfda77bf 100644 --- a/src/libvalent/media/valent-media-player.c +++ b/src/libvalent/media/valent-media-player.c @@ -17,7 +17,7 @@ * * A base class for media players. * - * A #ValentMediaPlayer is a base class for plugins to providing an interface to + * A `ValentMediaPlayer` is a base class for plugins to providing an interface to * media players via [class@Valent.MediaAdapter]. * * Since: 1.0 @@ -33,18 +33,18 @@ G_DEFINE_TYPE (ValentMediaPlayer, valent_media_player, VALENT_TYPE_OBJECT) * @previous: the virtual function pointer for valent_media_player_previous() * @seek: the virtual function pointer for valent_media_player_seek() * @stop: the virtual function pointer for valent_media_player_stop() - * @get_flags: Getter for the #ValentMediaPlayer:flags property. - * @get_metadata: Getter for the #ValentMediaPlayer:metadata property. - * @get_name: Getter for the #ValentMediaPlayer:name property. - * @get_position: Getter for the #ValentMediaPlayer:position property. - * @set_position: Setter for the #ValentMediaPlayer:position property. - * @get_repeat: Getter for the #ValentMediaPlayer:repeat property. - * @set_repeat: Setter for the #ValentMediaPlayer:repeat property. - * @get_state: Getter for the #ValentMediaPlayer:state property. - * @get_volume: Getter for the #ValentMediaPlayer:volume property. - * @set_volume: Setter for the #ValentMediaPlayer:volume property. - * - * Virtual table for #ValentMediaPlayer + * @get_flags: Getter for the `ValentMediaPlayer`:flags property. + * @get_metadata: Getter for the `ValentMediaPlayer`:metadata property. + * @get_name: Getter for the `ValentMediaPlayer`:name property. + * @get_position: Getter for the `ValentMediaPlayer`:position property. + * @set_position: Setter for the `ValentMediaPlayer`:position property. + * @get_repeat: Getter for the `ValentMediaPlayer`:repeat property. + * @set_repeat: Setter for the `ValentMediaPlayer`:repeat property. + * @get_state: Getter for the `ValentMediaPlayer`:state property. + * @get_volume: Getter for the `ValentMediaPlayer`:volume property. + * @set_volume: Setter for the `ValentMediaPlayer`:volume property. + * + * Virtual table for `ValentMediaPlayer` */ enum { @@ -448,11 +448,11 @@ valent_media_player_init (ValentMediaPlayer *self) /** * valent_media_player_get_flags: (virtual get_flags) (get-property flags) - * @player: a #ValentMediaPlayer + * @player: a `ValentMediaPlayer` * * Get flags describing the available actions of @player. * - * Returns: a bitmask of #ValentMediaActions + * Returns: a bitmask of `ValentMediaActions` * * Since: 1.0 */ @@ -472,7 +472,7 @@ valent_media_player_get_flags (ValentMediaPlayer *player) /** * valent_media_player_get_metadata: (virtual get_metadata) (get-property metadata) - * @player: a #ValentMediaPlayer + * @player: a `ValentMediaPlayer` * * Get the metadata of the active media items. * @@ -480,7 +480,7 @@ valent_media_player_get_flags (ValentMediaPlayer *player) * Other fields generally supported by KDE Connect clients include * `mpris:artUrl`, `xesam:artist`, `xesam:album` and `xesam:title`. * - * Returns: (transfer full): a #GVariant of type `a{sv}` + * Returns: (transfer full): a `GVariant` of type `a{sv}` * * Since: 1.0 */ @@ -503,7 +503,7 @@ valent_media_player_get_metadata (ValentMediaPlayer *player) /** * valent_media_player_get_name: (virtual get_name) (get-property name) - * @player: a #ValentMediaPlayer + * @player: a `ValentMediaPlayer` * * Get the display name of the @player. * @@ -527,7 +527,7 @@ valent_media_player_get_name (ValentMediaPlayer *player) /** * valent_media_player_get_position: (virtual get_position) (get-property position) - * @player: a #ValentMediaPlayer + * @player: a `ValentMediaPlayer` * * Get the current position in seconds. * @@ -551,7 +551,7 @@ valent_media_player_get_position (ValentMediaPlayer *player) /** * valent_media_player_set_position: (virtual set_position) (set-property position) - * @player: a #ValentMediaPlayer + * @player: a `ValentMediaPlayer` * @position: position in seconds * * Set the current position in seconds. @@ -574,11 +574,11 @@ valent_media_player_set_position (ValentMediaPlayer *player, /** * valent_media_player_get_repeat: (virtual get_repeat) (get-property repeat) - * @player: a #ValentMediaPlayer + * @player: a `ValentMediaPlayer` * * Get the repeat mode for @player. * - * Returns: #ValentMediaRepeat + * Returns: `ValentMediaRepeat` * * Since: 1.0 */ @@ -598,8 +598,8 @@ valent_media_player_get_repeat (ValentMediaPlayer *player) /** * valent_media_player_set_repeat: (virtual set_repeat) (set-property repeat) - * @player: a #ValentMediaPlayer - * @repeat: a #ValentMediaRepeat + * @player: a `ValentMediaPlayer` + * @repeat: a `ValentMediaRepeat` * * Set the repeat mode of @player to @repeat. * @@ -620,7 +620,7 @@ valent_media_player_set_repeat (ValentMediaPlayer *player, /** * valent_media_player_get_shuffle: (virtual get_shuffle) (get-property shuffle) - * @player: a #ValentMediaPlayer + * @player: a `ValentMediaPlayer` * * Get whether playback order is shuffled. * @@ -644,7 +644,7 @@ valent_media_player_get_shuffle (ValentMediaPlayer *player) /** * valent_media_player_set_shuffle: (virtual set_shuffle) (set-property shuffle) - * @player: a #ValentMediaPlayer + * @player: a `ValentMediaPlayer` * @shuffle: shuffle state * * Set whether playback order is shuffled. @@ -666,11 +666,11 @@ valent_media_player_set_shuffle (ValentMediaPlayer *player, /** * valent_media_player_get_state: (virtual get_state) (get-property state) - * @player: a #ValentMediaPlayer + * @player: a `ValentMediaPlayer` * * Get the playback state for @player. * - * Returns: #ValentMediaState + * Returns: `ValentMediaState` * * Since: 1.0 */ @@ -690,7 +690,7 @@ valent_media_player_get_state (ValentMediaPlayer *player) /** * valent_media_player_get_volume: (virtual get_volume) (get-property volume) - * @player: a #ValentMediaPlayer + * @player: a `ValentMediaPlayer` * * Get the volume level. * @@ -714,7 +714,7 @@ valent_media_player_get_volume (ValentMediaPlayer *player) /** * valent_media_player_set_volume: (virtual set_volume) (set-property volume) - * @player: a #ValentMediaPlayer + * @player: a `ValentMediaPlayer` * @volume: volume level * * Set the volume level of @player. @@ -736,7 +736,7 @@ valent_media_player_set_volume (ValentMediaPlayer *player, /** * valent_media_player_next: (virtual next) - * @player: a #ValentMediaPlayer + * @player: a `ValentMediaPlayer` * * Skip to the next media item. * @@ -762,7 +762,7 @@ valent_media_player_next (ValentMediaPlayer *player) /** * valent_media_player_pause: (virtual pause) - * @player: a #ValentMediaPlayer + * @player: a `ValentMediaPlayer` * * Pauses playback. * @@ -789,7 +789,7 @@ valent_media_player_pause (ValentMediaPlayer *player) /** * valent_media_player_play: (virtual play) - * @player: a #ValentMediaPlayer + * @player: a `ValentMediaPlayer` * * Start playback. * @@ -815,7 +815,7 @@ valent_media_player_play (ValentMediaPlayer *player) /** * valent_media_player_previous: (virtual previous) - * @player: a #ValentMediaPlayer + * @player: a `ValentMediaPlayer` * * Skip to the previous media item. * @@ -841,7 +841,7 @@ valent_media_player_previous (ValentMediaPlayer *player) /** * valent_media_player_seek: (virtual seek) - * @player: a #ValentMediaPlayer + * @player: a `ValentMediaPlayer` * @offset: number of seconds to seek forward * * Seek in the current media item by @offset seconds. @@ -871,7 +871,7 @@ valent_media_player_seek (ValentMediaPlayer *player, /** * valent_media_player_stop: (virtual stop) - * @player: a #ValentMediaPlayer + * @player: a `ValentMediaPlayer` * * Stop playback. * diff --git a/src/libvalent/media/valent-media.c b/src/libvalent/media/valent-media.c index 6a2f737fbe..e019d2eeb8 100644 --- a/src/libvalent/media/valent-media.c +++ b/src/libvalent/media/valent-media.c @@ -19,7 +19,7 @@ * * A class for monitoring and controlling media players. * - * #ValentMedia is an aggregator of media players, intended for use by + * `ValentMedia` is an aggregator of media players, intended for use by * [class@Valent.DevicePlugin] implementations. * * Plugins can implement [class@Valent.MediaAdapter] to provide an @@ -273,7 +273,7 @@ valent_media_init (ValentMedia *self) * * Get the default [class@Valent.Media]. * - * Returns: (transfer none) (not nullable): a #ValentMedia + * Returns: (transfer none) (not nullable): a `ValentMedia` * * Since: 1.0 */ @@ -296,8 +296,8 @@ valent_media_get_default (void) /** * valent_media_export_player: - * @media: a #ValentMedia - * @player: a #ValentMediaPlayer + * @media: a `ValentMedia` + * @player: a `ValentMediaPlayer` * * Export @player on all adapters that support it. * @@ -337,8 +337,8 @@ valent_media_export_player (ValentMedia *media, /** * valent_media_unexport_player: - * @media: a #ValentMedia - * @player: a #ValentMediaPlayer + * @media: a `ValentMedia` + * @player: a `ValentMediaPlayer` * * Unexport @player from all adapters that support it. * @@ -380,7 +380,7 @@ valent_media_unexport_player (ValentMedia *media, /** * valent_media_pause: - * @media: a #ValentMedia + * @media: a `ValentMedia` * * Pause any playing media players. Any player whose playback status is changed * will be tracked so that playback may be resumed with valent_media_play(). @@ -412,7 +412,7 @@ valent_media_pause (ValentMedia *media) /** * valent_media_unpause: - * @media: a #ValentMedia + * @media: a `ValentMedia` * * Unpause any media players we previously paused. * diff --git a/src/libvalent/mixer/valent-mixer-adapter.c b/src/libvalent/mixer/valent-mixer-adapter.c index 1c401c7854..f4d8880c8f 100644 --- a/src/libvalent/mixer/valent-mixer-adapter.c +++ b/src/libvalent/mixer/valent-mixer-adapter.c @@ -17,7 +17,7 @@ * * An abstract base class for audio mixers. * - * #ValentMixerAdapter is a base class for plugins that provide an interface to + * `ValentMixerAdapter` is a base class for plugins that provide an interface to * audio mixers and volume control. This usually means monitoring the available * input and output streams, changing properties on those streams, and selecting * which are the active input and output. @@ -53,7 +53,7 @@ G_DEFINE_ABSTRACT_TYPE_WITH_CODE (ValentMixerAdapter, valent_mixer_adapter, VALE * @get_default_output: the virtual function pointer for valent_mixer_adapter_get_default_output() * @set_default_output: the virtual function pointer for valent_mixer_adapter_set_default_output() * - * The virtual function table for #ValentMixerAdapter. + * The virtual function table for `ValentMixerAdapter`. */ enum { @@ -269,8 +269,8 @@ valent_mixer_adapter_init (ValentMixerAdapter *self) /** * valent_mixer_adapter_stream_added: - * @adapter: a #ValentMixerAdapter - * @stream: a #ValentMixerStream + * @adapter: a `ValentMixerAdapter` + * @stream: a `ValentMixerStream` * * Called when @stream has been added to the mixer. * @@ -297,8 +297,8 @@ valent_mixer_adapter_stream_added (ValentMixerAdapter *adapter, /** * valent_mixer_adapter_stream_removed: - * @adapter: a #ValentMixerAdapter - * @stream: a #ValentMixerStream + * @adapter: a `ValentMixerAdapter` + * @stream: a `ValentMixerStream` * * Called when @stream has been removed from the mixer. * @@ -328,11 +328,11 @@ valent_mixer_adapter_stream_removed (ValentMixerAdapter *adapter, /** * valent_mixer_adapter_get_default_input: (get-property default-input) (virtual get_default_input) - * @adapter: a #ValentMixerAdapter + * @adapter: a `ValentMixerAdapter` * * Get the default input stream for @adapter. * - * Returns: (transfer none): a #ValentMixerStream + * Returns: (transfer none): a `ValentMixerStream` * * Since: 1.0 */ @@ -352,8 +352,8 @@ valent_mixer_adapter_get_default_input (ValentMixerAdapter *adapter) /** * valent_mixer_adapter_set_default_input: (set-property default-input) (virtual set_default_input) - * @adapter: a #ValentMixerAdapter - * @stream: a #ValentMixerStream + * @adapter: a `ValentMixerAdapter` + * @stream: a `ValentMixerStream` * * Set the default input stream for @adapter to @stream. * @@ -375,11 +375,11 @@ valent_mixer_adapter_set_default_input (ValentMixerAdapter *adapter, /** * valent_mixer_adapter_get_default_output: (get-property default-output) (virtual get_default_output) - * @adapter: a #ValentMixerAdapter + * @adapter: a `ValentMixerAdapter` * * Get the default output stream for @adapter. * - * Returns: (transfer none): a #ValentMixerStream + * Returns: (transfer none): a `ValentMixerStream` * * Since: 1.0 */ @@ -399,8 +399,8 @@ valent_mixer_adapter_get_default_output (ValentMixerAdapter *adapter) /** * valent_mixer_adapter_set_default_output: (set-property default-output) (virtual set_default_output) - * @adapter: a #ValentMixerAdapter - * @stream: a #ValentMixerStream + * @adapter: a `ValentMixerAdapter` + * @stream: a `ValentMixerStream` * * Set the default output stream for @adapter to @stream. * diff --git a/src/libvalent/mixer/valent-mixer-stream.c b/src/libvalent/mixer/valent-mixer-stream.c index 334713ceab..9f9a248f9d 100644 --- a/src/libvalent/mixer/valent-mixer-stream.c +++ b/src/libvalent/mixer/valent-mixer-stream.c @@ -16,7 +16,7 @@ * * A base class for mixer streams. * - * #ValentMixerStream is a base class for mixer streams, intended for use by + * `ValentMixerStream` is a base class for mixer streams, intended for use by * implementations of [class@Valent.MixerAdapter]. * * Since: 1.0 @@ -54,7 +54,7 @@ static GParamSpec *properties[N_PROPERTIES] = { NULL, }; * @get_muted: the virtual function pointer for valent_mixer_stream_get_muted() * @set_muted: the virtual function pointer for valent_mixer_stream_set_muted() * - * The virtual function table for #ValentMixerStream. + * The virtual function table for `ValentMixerStream`. */ /* LCOV_EXCL_START */ @@ -323,7 +323,7 @@ valent_mixer_stream_init (ValentMixerStream *stream) /** * valent_mixer_stream_get_name: (get-property name) (virtual get_name) - * @stream: a #ValentMixerStream + * @stream: a `ValentMixerStream` * * Get the unique name of @stream. * @@ -347,7 +347,7 @@ valent_mixer_stream_get_name (ValentMixerStream *stream) /** * valent_mixer_stream_get_description: (get-property description) (virtual get_description) - * @stream: a #ValentMixerStream + * @stream: a `ValentMixerStream` * * Get the human-readable label of @stream. * @@ -371,11 +371,11 @@ valent_mixer_stream_get_description (ValentMixerStream *stream) /** * valent_mixer_stream_get_direction: (get-property direction) (virtual get_direction) - * @stream: a #ValentMixerStream + * @stream: a `ValentMixerStream` * * Get the port direction of @stream. * - * Returns: the #ValentMixerDirection of @stream + * Returns: the `ValentMixerDirection` of @stream * * Since: 1.0 */ @@ -391,7 +391,7 @@ valent_mixer_stream_get_direction (ValentMixerStream *stream) /** * valent_mixer_stream_get_level: (get-property level) (virtual get_level) - * @stream: a #ValentMixerStream + * @stream: a `ValentMixerStream` * * Get the level of @stream (eg. speaker volume, microphone sensitivity). * @@ -418,7 +418,7 @@ valent_mixer_stream_get_level (ValentMixerStream *stream) /** * valent_mixer_stream_set_level: (set-property level) (virtual set_level) - * @stream: a #ValentMixerStream + * @stream: a `ValentMixerStream` * @level: a volume level between `0` and `100` * * Set the level of @stream (eg. speaker volume, microphone sensitivity). @@ -444,7 +444,7 @@ valent_mixer_stream_set_level (ValentMixerStream *stream, /** * valent_mixer_stream_get_muted: (get-property muted) (virtual get_muted) - * @stream: a #ValentMixerStream + * @stream: a `ValentMixerStream` * * Get the muted state of @stream. * @@ -471,7 +471,7 @@ valent_mixer_stream_get_muted (ValentMixerStream *stream) /** * valent_mixer_stream_set_muted: (set-property muted) (virtual set_muted) - * @stream: a #ValentMixerStream + * @stream: a `ValentMixerStream` * @state: whether the stream should be muted * * Set the muted state of @stream. diff --git a/src/libvalent/mixer/valent-mixer.c b/src/libvalent/mixer/valent-mixer.c index 06efc97822..629cc1565d 100644 --- a/src/libvalent/mixer/valent-mixer.c +++ b/src/libvalent/mixer/valent-mixer.c @@ -19,7 +19,7 @@ * * A class for monitoring and controlling the system volume. * - * #ValentMixer is an abstraction of volume mixers, intended for use by + * `ValentMixer` is an abstraction of volume mixers, intended for use by * [class@Valent.DevicePlugin] implementations. * * Plugins can implement [class@Valent.MixerAdapter] to provide an interface to @@ -328,7 +328,7 @@ valent_mixer_init (ValentMixer *self) * * Get the default [class@Valent.Mixer]. * - * Returns: (transfer none) (not nullable): a #ValentMixer + * Returns: (transfer none) (not nullable): a `ValentMixer` * * Since: 1.0 */ @@ -351,11 +351,11 @@ valent_mixer_get_default (void) /** * valent_mixer_get_default_input: (get-property default-input) - * @mixer: a #ValentMixer + * @mixer: a `ValentMixer` * * Get the default input stream for the primary [class@Valent.MixerAdapter]. * - * Returns: (transfer none) (nullable): a #ValentMixerStream + * Returns: (transfer none) (nullable): a `ValentMixerStream` * * Since: 1.0 */ @@ -376,8 +376,8 @@ valent_mixer_get_default_input (ValentMixer *mixer) /** * valent_mixer_set_default_input: (set-property default-input) - * @mixer: a #ValentMixer - * @stream: a #ValentMixerStream + * @mixer: a `ValentMixer` + * @stream: a `ValentMixerStream` * * Set the default input stream for the primary [class@Valent.MixerAdapter]. * @@ -400,11 +400,11 @@ valent_mixer_set_default_input (ValentMixer *mixer, /** * valent_mixer_get_default_output: (get-property default-output) - * @mixer: a #ValentMixer + * @mixer: a `ValentMixer` * * Get the default output stream for the primary [class@Valent.MixerAdapter]. * - * Returns: (transfer none) (nullable): a #ValentMixerStream + * Returns: (transfer none) (nullable): a `ValentMixerStream` * * Since: 1.0 */ @@ -425,8 +425,8 @@ valent_mixer_get_default_output (ValentMixer *mixer) /** * valent_mixer_set_default_output: (set-property default-output) - * @mixer: a #ValentMixer - * @stream: a #ValentMixerStream + * @mixer: a `ValentMixer` + * @stream: a `ValentMixerStream` * * Set the default output stream for the primary [class@Valent.MixerAdapter]. * diff --git a/src/libvalent/notifications/valent-notification.c b/src/libvalent/notifications/valent-notification.c index 88fe1c081b..d0a255ec02 100644 --- a/src/libvalent/notifications/valent-notification.c +++ b/src/libvalent/notifications/valent-notification.c @@ -15,7 +15,7 @@ * * A class representing a notification. * - * #ValentNotification is a derivable, generic class for a notification. + * `ValentNotification` is a derivable, generic class for a notification. * * Since: 1.0 */ @@ -379,13 +379,13 @@ valent_notification_class_init (ValentNotificationClass *klass) * valent_notification_new: * @title: (nullable): a notification title * - * Create a new #ValentNotification. + * Create a new `ValentNotification`. * * A notification without a title (or primary text) is not strictly possible, * but this is allowed during construction for the case where it is more * convenient to set it later. * - * Returns: (transfer full): a #ValentNotification + * Returns: (transfer full): a `ValentNotification` * * Since: 1.0 */ @@ -402,7 +402,7 @@ valent_notification_new (const char *title) /** * valent_notification_set_action: - * @notification: a #ValentNotification + * @notification: a `ValentNotification` * @action: a detailed action * * Sets the default notification action. @@ -433,7 +433,7 @@ valent_notification_set_action (ValentNotification *notification, /** * valent_notification_get_application: (get-property application) - * @notification: a #ValentNotification + * @notification: a `ValentNotification` * * Get the notifying application. * @@ -451,7 +451,7 @@ valent_notification_get_application (ValentNotification *notification) /** * valent_notification_set_application: (set-property application) - * @notification: a #ValentNotification + * @notification: a `ValentNotification` * @application: (nullable): the notifying application * * Set the notifying application. @@ -470,7 +470,7 @@ valent_notification_set_application (ValentNotification *notification, /** * valent_notification_get_body: (get-property body) - * @notification: a #ValentNotification + * @notification: a `ValentNotification` * * Get the notification body. * @@ -488,7 +488,7 @@ valent_notification_get_body (ValentNotification *notification) /** * valent_notification_set_body: (set-property body) - * @notification: a #ValentNotification + * @notification: a `ValentNotification` * @body: (nullable): a notification body * * Set the notification body. @@ -507,11 +507,11 @@ valent_notification_set_body (ValentNotification *notification, /** * valent_notification_get_icon: (set-property icon) - * @notification: a #ValentNotification + * @notification: a `ValentNotification` * * Get the notification icon. * - * Returns: (transfer none) (nullable): a #GIcon + * Returns: (transfer none) (nullable): a `GIcon` * * Since: 1.0 */ @@ -525,8 +525,8 @@ valent_notification_get_icon (ValentNotification *notification) /** * valent_notification_set_icon: (set-property icon) - * @notification: a #ValentNotification - * @icon: (nullable): a #GIcon + * @notification: a `ValentNotification` + * @icon: (nullable): a `GIcon` * * Set the notification icon. * @@ -548,7 +548,7 @@ valent_notification_set_icon (ValentNotification *notification, /** * valent_notification_get_id: (get-property id) - * @notification: a #ValentNotification + * @notification: a `ValentNotification` * * Get the notification ID. * @@ -566,7 +566,7 @@ valent_notification_get_id (ValentNotification *notification) /** * valent_notification_set_id: (set-property id) - * @notification: a #ValentNotification + * @notification: a `ValentNotification` * @id: (not nullable): a unique ID * * Set the notification ID. @@ -586,11 +586,11 @@ valent_notification_set_id (ValentNotification *notification, /** * valent_notification_get_priority: - * @notification: a #ValentNotification + * @notification: a `ValentNotification` * * Get the notification priority. * - * Returns: a #GNotificationPriority + * Returns: a `GNotificationPriority` * * Since: 1.0 */ @@ -604,8 +604,8 @@ valent_notification_get_priority (ValentNotification *notification) /** * valent_notification_set_priority: - * @notification: a #ValentNotification - * @priority: a #GNotificationPriority + * @notification: a `ValentNotification` + * @priority: a `GNotificationPriority` * * Set the notification priority. * @@ -626,7 +626,7 @@ valent_notification_set_priority (ValentNotification *notification, /** * valent_notification_get_time: (get-property time) - * @notification: a #ValentNotification + * @notification: a `ValentNotification` * * Get the notification time. * @@ -644,7 +644,7 @@ valent_notification_get_time (ValentNotification *notification) /** * valent_notification_set_time: (set-property time) - * @notification: a #ValentNotification + * @notification: a `ValentNotification` * @time: a UNIX epoch timestamp (ms) * * Set the notification time. @@ -666,7 +666,7 @@ valent_notification_set_time (ValentNotification *notification, /** * valent_notification_get_title: (get-property title) - * @notification: a #ValentNotification + * @notification: a `ValentNotification` * * Get the notification title. * @@ -684,7 +684,7 @@ valent_notification_get_title (ValentNotification *notification) /** * valent_notification_set_title: (set-property title) - * @notification: a #ValentNotification + * @notification: a `ValentNotification` * @title: (not nullable): a notification title * * Set the notification title. @@ -704,7 +704,7 @@ valent_notification_set_title (ValentNotification *notification, /** * valent_notification_add_button_with_target: - * @notification: a #ValentNotification + * @notification: a `ValentNotification` * @label: a button label * @action: an action name * @target: (nullable): an action target @@ -738,7 +738,7 @@ valent_notification_add_button_with_target (ValentNotification *notification, /** * valent_notification_add_button: - * @notification: a #ValentNotification + * @notification: a `ValentNotification` * @label: a button label * @action: an action name * @@ -771,9 +771,9 @@ valent_notification_add_button (ValentNotification *notification, /** * valent_notification_set_action_and_target: - * @notification: a #ValentNotification + * @notification: a `ValentNotification` * @action: an action name - * @target: (nullable): a #GVariant to use as @action's parameter + * @target: (nullable): a `GVariant` to use as @action's parameter * * Set the default notification action. * @@ -799,11 +799,11 @@ valent_notification_set_action_and_target (ValentNotification *notification, /** * valent_notification_serialize: - * @notification: a #ValentNotification + * @notification: a `ValentNotification` * * Serialize the notification into a variant of type `a{sv}`. * - * Returns: (nullable): a floating #GVariant + * Returns: (nullable): a floating `GVariant` * * Since: 1.0 */ @@ -877,13 +877,13 @@ valent_notification_serialize (ValentNotification *notification) /** * valent_notification_deserialize: - * @variant: a #GVariant + * @variant: a `GVariant` * - * Deserializes @variant into a #ValentNotification. Since #ValentNotification - * is effectively a super-set of #GNotification, @variant may be a serialized - * #GNotification or #ValentNotification. + * Deserializes @variant into a `ValentNotification`. Since `ValentNotification` + * is effectively a super-set of `GNotification`, @variant may be a serialized + * `GNotification` or `ValentNotification`. * - * Returns: (transfer full) (nullable): a #ValentNotification + * Returns: (transfer full) (nullable): a `ValentNotification` * * Since: 1.0 */ @@ -969,7 +969,7 @@ valent_notification_deserialize (GVariant *variant) /** * valent_notification_hash: - * @notification: (type Valent.Notification): a #ValentNotification + * @notification: (type Valent.Notification): a `ValentNotification` * * Converts a notification to a hash value, using g_str_hash() on the ID. * @@ -987,8 +987,8 @@ valent_notification_hash (gconstpointer notification) /** * valent_notification_equal: - * @notification1: (type Valent.Notification): a #ValentNotification - * @notification2: (type Valent.Notification): a #ValentNotification + * @notification1: (type Valent.Notification): a `ValentNotification` + * @notification2: (type Valent.Notification): a `ValentNotification` * * Compare two notifications for equality by ID. * diff --git a/src/libvalent/notifications/valent-notifications-adapter.c b/src/libvalent/notifications/valent-notifications-adapter.c index 6be1ac23d9..f8a77a7dc4 100644 --- a/src/libvalent/notifications/valent-notifications-adapter.c +++ b/src/libvalent/notifications/valent-notifications-adapter.c @@ -16,7 +16,7 @@ * * An abstract base class for notification servers. * - * #ValentNotificationsAdapter is a base class for notification servers. This + * `ValentNotificationsAdapter` is a base class for notification servers. This * usually means monitoring a D-Bus service for notifications being sent and * withdrawn. * @@ -43,10 +43,10 @@ G_DEFINE_ABSTRACT_TYPE_WITH_PRIVATE (ValentNotificationsAdapter, valent_notifica * ValentNotificationsAdapterClass: * @add_notification: the virtual function pointer for valent_notifications_adapter_add_notification() * @remove_notification: the virtual function pointer for valent_notifications_adapter_remove_notification() - * @notification_added: the class closure for #ValentNotificationsAdapter::notification-added signal - * @notification_removed: the class closure for #ValentNotificationsAdapter::notification-removed signal + * @notification_added: the class closure for `ValentNotificationsAdapter`::notification-added signal + * @notification_removed: the class closure for `ValentNotificationsAdapter`::notification-removed signal * - * The virtual function table for #ValentNotificationsAdapter. + * The virtual function table for `ValentNotificationsAdapter`. */ enum { @@ -83,8 +83,8 @@ valent_notifications_adapter_class_init (ValentNotificationsAdapterClass *klass) /** * ValentNotificationsAdapter::notification-added: - * @adapter: a #ValentNotificationsAdapter - * @notification: a #ValentNotification + * @adapter: a `ValentNotificationsAdapter` + * @notification: a `ValentNotification` * * Emitted when a [class@Valent.Notification] is added to @adapter. * @@ -107,8 +107,8 @@ valent_notifications_adapter_class_init (ValentNotificationsAdapterClass *klass) /** * ValentNotificationsAdapter::notification-removed: - * @adapter: a #ValentNotificationsAdapter - * @notification: a #ValentNotification + * @adapter: a `ValentNotificationsAdapter` + * @notification: a `ValentNotification` * * Emitted when a [class@Valent.Notification] is removed from @adapter. * @@ -137,8 +137,8 @@ valent_notifications_adapter_init (ValentNotificationsAdapter *adapter) /** * valent_notifications_adapter_notification_added: - * @adapter: a #ValentNotificationsAdapter - * @notification: a #ValentNotification + * @adapter: a `ValentNotificationsAdapter` + * @notification: a `ValentNotification` * * Emit [signal@Valent.NotificationsAdapter::notification-added] on @adapter. * @@ -158,7 +158,7 @@ valent_notifications_adapter_notification_added (ValentNotificationsAdapter *ada /** * valent_notifications_adapter_notification_removed: - * @adapter: a #ValentNotificationsAdapter + * @adapter: a `ValentNotificationsAdapter` * @id: a notification id * * Emit [signal@Valent.NotificationsAdapter::notification-removed] on @adapter. @@ -179,8 +179,8 @@ valent_notifications_adapter_notification_removed (ValentNotificationsAdapter *a /** * valent_notifications_adapter_add_notification: (virtual add_notification) - * @adapter: a #ValentNotificationsAdapter - * @notification: a #ValentNotification + * @adapter: a `ValentNotificationsAdapter` + * @notification: a `ValentNotification` * * Send @notification to the @adapter. * @@ -203,7 +203,7 @@ valent_notifications_adapter_add_notification (ValentNotificationsAdapter *adapt /** * valent_notifications_adapter_remove_notification: (virtual remove_notification) - * @adapter: a #ValentNotificationsAdapter + * @adapter: a `ValentNotificationsAdapter` * @id: a notification id * * Withdraw @id from @adapter. diff --git a/src/libvalent/notifications/valent-notifications.c b/src/libvalent/notifications/valent-notifications.c index 15cf4ddf89..0cbc35fe82 100644 --- a/src/libvalent/notifications/valent-notifications.c +++ b/src/libvalent/notifications/valent-notifications.c @@ -20,7 +20,7 @@ * * A class for sending and receiving notifications. * - * #ValentNotifications is an aggregator of notifications, intended for use by + * `ValentNotifications` is an aggregator of notifications, intended for use by * [class@Valent.DevicePlugin] implementations. * * Plugins can implement [class@Valent.NotificationsAdapter] to provide an @@ -249,8 +249,8 @@ valent_notifications_class_init (ValentNotificationsClass *klass) /** * ValentNotifications::notification-added: - * @notifications: a #ValentNotifications - * @notification: a #ValentNotification + * @notifications: a `ValentNotifications` + * @notification: a `ValentNotification` * * Emitted when a notification is added to a * [class@Valent.NotificationsAdapter]. @@ -271,7 +271,7 @@ valent_notifications_class_init (ValentNotificationsClass *klass) /** * ValentNotifications::notification-removed: - * @notifications: a #ValentNotifications + * @notifications: a `ValentNotifications` * @id: a notification id * * Emitted when a notification is removed from a @@ -303,7 +303,7 @@ valent_notifications_init (ValentNotifications *self) * * Get the default [class@Valent.Notifications]. * - * Returns: (transfer none) (not nullable): a #ValentNotifications + * Returns: (transfer none) (not nullable): a `ValentNotifications` * * Since: 1.0 */ @@ -326,11 +326,11 @@ valent_notifications_get_default (void) /** * valent_notifications_get_applications: - * @notifications: (nullable): a #ValentNotifications + * @notifications: (nullable): a `ValentNotifications` * * Get a dictionary of applications that are known to send notifications. * - * Returns: (transfer none): a #GVariant + * Returns: (transfer none): a `GVariant` * * Since: 1.0 */ diff --git a/src/libvalent/session/valent-session-adapter.c b/src/libvalent/session/valent-session-adapter.c index 2992228607..0d61cbd778 100644 --- a/src/libvalent/session/valent-session-adapter.c +++ b/src/libvalent/session/valent-session-adapter.c @@ -16,7 +16,7 @@ * * An abstract base class for session managers. * - * #ValentSessionAdapter is a base class for plugins that provide an interface + * `ValentSessionAdapter` is a base class for plugins that provide an interface * to the desktop session manager. This usually means monitoring the idle state, * locking and unlocking the session. * @@ -46,7 +46,7 @@ G_DEFINE_ABSTRACT_TYPE_WITH_PRIVATE (ValentSessionAdapter, valent_session_adapte * @get_locked: the virtual function pointer for valent_session_adapter_get_locked() * @set_locked: the virtual function pointer for valent_session_adapter_set_locked() * - * The virtual function table for #ValentSessionAdapter. + * The virtual function table for `ValentSessionAdapter`. */ enum { @@ -191,7 +191,7 @@ valent_session_adapter_init (ValentSessionAdapter *adapter) /** * valent_session_adapter_get_active: (virtual get_active) (get-property active) - * @adapter: a #ValentSessionAdapter + * @adapter: a `ValentSessionAdapter` * * Get whether the session is active. * @@ -215,7 +215,7 @@ valent_session_adapter_get_active (ValentSessionAdapter *adapter) /** * valent_session_adapter_get_locked: (virtual get_locked) (get-property locked) - * @adapter: a #ValentSessionAdapter + * @adapter: a `ValentSessionAdapter` * * Get whether the session is locked. * @@ -239,7 +239,7 @@ valent_session_adapter_get_locked (ValentSessionAdapter *adapter) /** * valent_session_adapter_set_locked: (virtual set_locked) (set-property locked) - * @adapter: a #ValentSessionAdapter + * @adapter: a `ValentSessionAdapter` * @state: %TRUE to lock, %FALSE to unlock * * Set whether the session is locked. diff --git a/src/libvalent/session/valent-session.c b/src/libvalent/session/valent-session.c index 6b8e2fb807..fb23c7358c 100644 --- a/src/libvalent/session/valent-session.c +++ b/src/libvalent/session/valent-session.c @@ -18,7 +18,7 @@ * * A class for monitoring the session state. * - * #ValentSession is an abstraction of session managers, intended for use by + * `ValentSession` is an abstraction of session managers, intended for use by * [class@Valent.DevicePlugin] implementations. * * Plugins can implement [class@Valent.SessionAdapter] to provide an interface @@ -213,7 +213,7 @@ valent_session_init (ValentSession *self) * * Get the default [class@Valent.Session]. * - * Returns: (transfer none) (nullable): a #ValentSession + * Returns: (transfer none) (nullable): a `ValentSession` * * Since: 1.0 */ @@ -236,7 +236,7 @@ valent_session_get_default (void) /** * valent_session_get_active: (get-property active) - * @session: a #ValentSession + * @session: a `ValentSession` * * Get the active state of the primary [class@Valent.SessionAdapter]. * @@ -261,7 +261,7 @@ valent_session_get_active (ValentSession *session) /** * valent_session_get_locked: (get-property locked) - * @session: a #ValentSession + * @session: a `ValentSession` * * Get the locked state of the primary [class@Valent.SessionAdapter]. * @@ -286,7 +286,7 @@ valent_session_get_locked (ValentSession *session) /** * valent_session_set_locked: (set-property locked) - * @session: a #ValentSession + * @session: a `ValentSession` * @state: %TRUE to lock, or %FALSE to unlock * * Set the locked state of the primary [class@Valent.SessionAdapter]. diff --git a/src/libvalent/ui/valent-device-gadget.c b/src/libvalent/ui/valent-device-gadget.c index 7f987708e3..19d69f59de 100644 --- a/src/libvalent/ui/valent-device-gadget.c +++ b/src/libvalent/ui/valent-device-gadget.c @@ -17,7 +17,7 @@ * * An abstract base class for device plugin gadgets. * - * #ValentDeviceGadget is an base class for [class@Valent.DevicePlugin] + * `ValentDeviceGadget` is an base class for [class@Valent.DevicePlugin] * implementations that want to provide a small widget to display or control a * simple state (e.g. battery level). * diff --git a/src/libvalent/ui/valent-device-preferences-group.c b/src/libvalent/ui/valent-device-preferences-group.c index 2000e52a2e..a9a85bda01 100644 --- a/src/libvalent/ui/valent-device-preferences-group.c +++ b/src/libvalent/ui/valent-device-preferences-group.c @@ -19,7 +19,7 @@ * * An abstract base class for device plugin preferences. * - * #ValentDevicePreferencesGroup is a base class for [class@Valent.DevicePlugin] + * `ValentDevicePreferencesGroup` is a base class for [class@Valent.DevicePlugin] * implementations that want to provide a group of preferences. * * Since: 1.0 @@ -176,11 +176,11 @@ valent_device_preferences_group_init (ValentDevicePreferencesGroup *self) /** * valent_device_preferences_group_get_context: - * @group: a #ValentDevicePreferencesGroup + * @group: a `ValentDevicePreferencesGroup` * * Get the [class@Valent.Context] for the [class@Valent.DevicePlugin]. * - * Returns: (transfer none) (nullable): a #ValentContext + * Returns: (transfer none) (nullable): a `ValentContext` * * Since: 1.0 */ @@ -204,7 +204,7 @@ valent_device_preferences_group_get_context (ValentDevicePreferencesGroup *group /** * valent_device_preferences_group_get_settings: - * @group: a #ValentDevicePreferencesGroup + * @group: a `ValentDevicePreferencesGroup` * * Get the [class@Gio.Settings] for the [class@Valent.DevicePlugin]. * diff --git a/src/libvalent/ui/valent-menu-list.c b/src/libvalent/ui/valent-menu-list.c index 079f6b9481..a58e5d867e 100644 --- a/src/libvalent/ui/valent-menu-list.c +++ b/src/libvalent/ui/valent-menu-list.c @@ -485,7 +485,7 @@ valent_menu_list_class_init (ValentMenuListClass *klass) /** * ValentMenuList:menu-model: * - * The "model" property holds the #GMenuModel used to build this list. + * The "model" property holds the `GMenuModel` used to build this list. */ properties [PROP_MENU_MODEL] = g_param_spec_object ("menu-model", NULL, NULL, @@ -497,7 +497,7 @@ valent_menu_list_class_init (ValentMenuListClass *klass) /** * ValentMenuList:submenu-of: * - * The parent #ValentMenuList this is a submenu for. + * The parent `ValentMenuList` this is a submenu for. */ properties [PROP_SUBMENU_OF] = g_param_spec_object ("submenu-of", NULL, NULL, @@ -537,11 +537,11 @@ valent_menu_list_init (ValentMenuList *self) /** * valent_menu_list_new: - * @model: (nullable): a #GMenuModel + * @model: (nullable): a `GMenuModel` * - * Create a new #ValentMenuList. + * Create a new `ValentMenuList`. * - * Returns: (transfer full): a #ValentMenuList + * Returns: (transfer full): a `ValentMenuList` */ ValentMenuList * valent_menu_list_new (GMenuModel *model) @@ -553,11 +553,11 @@ valent_menu_list_new (GMenuModel *model) /** * valent_menu_list_get_menu_model: - * @self: a #ValentMenuList + * @self: a `ValentMenuList` * - * Get the #GMenuModel for @self. + * Get the `GMenuModel` for @self. * - * Returns: (transfer none): a #GMenuModel + * Returns: (transfer none): a `GMenuModel` */ GMenuModel * valent_menu_list_get_menu_model (ValentMenuList *self) @@ -569,10 +569,10 @@ valent_menu_list_get_menu_model (ValentMenuList *self) /** * valent_menu_list_set_menu_model: - * @self: a #ValentMenuList - * @model: (nullable): a #GMenuModel + * @self: a `ValentMenuList` + * @model: (nullable): a `GMenuModel` * - * Set the #GMenuModel for @self. + * Set the `GMenuModel` for @self. */ void valent_menu_list_set_menu_model (ValentMenuList *list, @@ -603,11 +603,11 @@ valent_menu_list_set_menu_model (ValentMenuList *list, /** * valent_menu_list_get_submenu_of: - * @self: a #ValentMenuList + * @self: a `ValentMenuList` * - * Get the parent #ValentMenuList. + * Get the parent `ValentMenuList`. * - * Returns: (transfer none) (nullable): a #ValentMenuList + * Returns: (transfer none) (nullable): a `ValentMenuList` */ ValentMenuList * valent_menu_list_get_submenu_of (ValentMenuList *self) @@ -619,10 +619,10 @@ valent_menu_list_get_submenu_of (ValentMenuList *self) /** * valent_menu_list_set_submenu_of: - * @self: a #ValentMenuList - * @parent: (nullable): a #GMenuModel + * @self: a `ValentMenuList` + * @parent: (nullable): a `GMenuModel` * - * Set the #GMenuModel for @self. + * Set the `GMenuModel` for @self. */ void valent_menu_list_set_submenu_of (ValentMenuList *self, diff --git a/src/libvalent/ui/valent-menu-stack.c b/src/libvalent/ui/valent-menu-stack.c index 664f91ef0f..8e14d31cb8 100644 --- a/src/libvalent/ui/valent-menu-stack.c +++ b/src/libvalent/ui/valent-menu-stack.c @@ -97,7 +97,7 @@ valent_menu_stack_class_init (ValentMenuStackClass *klass) /** * ValentMenuStack:model: * - * The #GMenuModel for this #ValentMenuStack. + * The `GMenuModel` for this `ValentMenuStack`. */ properties [PROP_MENU_MODEL] = g_param_spec_object ("menu-model", NULL, NULL, @@ -122,11 +122,11 @@ valent_menu_stack_init (ValentMenuStack *self) /** * valent_menu_stack_new: - * @menu_model: (nullable): a #GMenuModel + * @menu_model: (nullable): a `GMenuModel` * - * Create a new #ValentMenuStack. + * Create a new `ValentMenuStack`. * - * Returns: a #GtkWidget + * Returns: a `GtkWidget` */ GtkWidget * valent_menu_stack_new (GMenuModel *menu_model) @@ -138,11 +138,11 @@ valent_menu_stack_new (GMenuModel *menu_model) /** * valent_menu_stack_get_model: - * @stack: a #ValentMenuStack + * @stack: a `ValentMenuStack` * - * Get the #GMenuModel for @stack. + * Get the `GMenuModel` for @stack. * - * Returns: (transfer none) (nullable): a #GMenuModel + * Returns: (transfer none) (nullable): a `GMenuModel` */ GMenuModel * valent_menu_stack_get_menu_model (ValentMenuStack *stack) @@ -157,10 +157,10 @@ valent_menu_stack_get_menu_model (ValentMenuStack *stack) /** * valent_menu_stack_set_model: - * @stack: a #ValentMenuStack - * @menu_model: (nullable): a #GMenuModel + * @stack: a `ValentMenuStack` + * @menu_model: (nullable): a `GMenuModel` * - * Set the #GMenuModel for @stack to @menu_model. + * Set the `GMenuModel` for @stack to @menu_model. */ void valent_menu_stack_set_menu_model (ValentMenuStack *stack, diff --git a/src/libvalent/ui/valent-preferences-page.c b/src/libvalent/ui/valent-preferences-page.c index 460ce2b425..cfa6f8834e 100644 --- a/src/libvalent/ui/valent-preferences-page.c +++ b/src/libvalent/ui/valent-preferences-page.c @@ -16,7 +16,7 @@ * * An abstract base class for plugin preferences. * - * #ValentPreferencesPage is a base class for plugins that want to provide a + * `ValentPreferencesPage` is a base class for plugins that want to provide a * preferences page. Unlike [class@Valent.DevicePreferencesGroup] the page should * configure all of the plugin's extension implementations, with the exception * of [class@Valent.DevicePlugin]. @@ -46,7 +46,7 @@ static GParamSpec *properties[N_PROPERTIES] = { NULL, }; /** * ValentPreferencesPageClass: * - * The virtual function table for #ValentPreferencesPage. + * The virtual function table for `ValentPreferencesPage`. * * Since: 1.0 */ diff --git a/src/plugins/battery/valent-battery.c b/src/plugins/battery/valent-battery.c index 0c257e3898..90b69edc50 100644 --- a/src/plugins/battery/valent-battery.c +++ b/src/plugins/battery/valent-battery.c @@ -314,9 +314,9 @@ valent_battery_class_init (ValentBatteryClass *klass) /** * ValentBattery::changed: - * @self: a #ValentBattery + * @self: a `ValentBattery` * - * #ValentBattery::changed is emitted whenever a relevant property changes. + * `ValentBattery`::changed is emitted whenever a relevant property changes. */ signals [CHANGED] = g_signal_new ("changed", @@ -350,9 +350,9 @@ valent_battery_init (ValentBattery *self) /** * valent_battery_get_default: * - * Get the default #ValentBattery. + * Get the default `ValentBattery`. * - * Returns: (transfer none): The default #ValentBattery + * Returns: (transfer none): The default `ValentBattery` */ ValentBattery * valent_battery_get_default (void) @@ -370,7 +370,7 @@ valent_battery_get_default (void) /** * valent_battery_current_charge: - * @battery: a #ValentBattery + * @battery: a `ValentBattery` * * Get the charge level of @battery. * @@ -392,7 +392,7 @@ valent_battery_current_charge (ValentBattery *battery) /** * valent_battery_is_charging: - * @battery: a #ValentBattery + * @battery: a `ValentBattery` * * Get whether the battery is charging. * @@ -411,7 +411,7 @@ valent_battery_is_charging (ValentBattery *battery) /** * valent_battery_is_present: - * @battery: a #ValentBattery + * @battery: a `ValentBattery` * * Get whether the battery is present. * @@ -427,7 +427,7 @@ valent_battery_is_present (ValentBattery *battery) /** * valent_battery_is_charging: - * @battery: a #ValentBattery + * @battery: a `ValentBattery` * * Get whether the battery is charging. * diff --git a/src/plugins/bluez/valent-bluez-channel.c b/src/plugins/bluez/valent-bluez-channel.c index f6e3fc0063..93ace8fefc 100644 --- a/src/plugins/bluez/valent-bluez-channel.c +++ b/src/plugins/bluez/valent-bluez-channel.c @@ -178,7 +178,7 @@ valent_bluez_channel_class_init (ValentBluezChannelClass *klass) /** * ValentBluezChannel:muxer: * - * The #ValentMuxConnection responsible for muxing and demuxing data. + * The `ValentMuxConnection` responsible for muxing and demuxing data. */ properties [PROP_MUXER] = g_param_spec_object ("muxer", NULL, NULL, diff --git a/src/plugins/bluez/valent-bluez-device.c b/src/plugins/bluez/valent-bluez-device.c index 89122c4510..f1712d88ce 100644 --- a/src/plugins/bluez/valent-bluez-device.c +++ b/src/plugins/bluez/valent-bluez-device.c @@ -255,14 +255,14 @@ valent_bluez_device_init (ValentBluezDevice *device) /** * valent_bluez_device_new: - * @connection: a #GDBusConnection + * @connection: a `GDBusConnection` * @object_path: An object path - * @props: a #GVariant + * @props: a `GVariant` * - * Create a new #ValentBluezDevice on @connection for @object_path. If @properties + * Create a new `ValentBluezDevice` on @connection for @object_path. If @properties * is not %NULL, the returned proxy will be populated. * - * Returns: (transfer full): a new #ValentBluezDevice + * Returns: (transfer full): a new `ValentBluezDevice` */ ValentBluezDevice * valent_bluez_device_new (GDBusConnection *connection, @@ -325,7 +325,7 @@ valent_bluez_device_connect_cb (GDBusConnection *connection, /** * valent_bluez_device_connect: - * @device: A #ValentBluezDevice + * @device: A `ValentBluezDevice` * * Attempt to connect @device. */ @@ -350,7 +350,7 @@ valent_bluez_device_connect (ValentBluezDevice *device) /** * valent_bluez_device_is_supported: - * @device: a #ValentBluezDevice + * @device: a `ValentBluezDevice` * * Returns %TRUE if @device is paired and the list of service UUIDs includes the * KDE Connect bluetooth UUID. diff --git a/src/plugins/bluez/valent-bluez-profile.c b/src/plugins/bluez/valent-bluez-profile.c index ab995b22de..d8863b8ca8 100644 --- a/src/plugins/bluez/valent-bluez-profile.c +++ b/src/plugins/bluez/valent-bluez-profile.c @@ -56,10 +56,10 @@ static const char interface_xml[] = /** * valent_bluez_profile_new_connection: - * @profile: a #ValentBluezProfile + * @profile: a `ValentBluezProfile` * @object_path: a DBus object path * @fd: a UNIX file descriptor - * @fd_properties: a #GVariant + * @fd_properties: a `GVariant` * * This method gets called when a new service level connection has been made and * authorized. @@ -95,7 +95,7 @@ valent_bluez_profile_new_connection (ValentBluezProfile *profile, /** * valent_bluez_profile_request_disconnection: - * @profile: a #ValentBluezProfile + * @profile: a `ValentBluezProfile` * @object_path: a DBus object path * * This method gets called when a profile gets disconnected. @@ -120,7 +120,7 @@ valent_bluez_profile_request_disconnection (ValentBluezProfile *profile, /** * valent_bluez_profile_release: - * @profile: a #ValentBluezProfile + * @profile: a `ValentBluezProfile` * * This method gets called when the service daemon unregisters the profile. * A profile can use it to do cleanup tasks. There is no need to unregister @@ -260,12 +260,12 @@ valent_bluez_profile_class_init (ValentBluezProfileClass *klass) { /** * ValentBluezProfile::connection-opened: - * @profile: a #ValentBluezProfile - * @connection: a #GSocketConnection + * @profile: a `ValentBluezProfile` + * @connection: a `GSocketConnection` * @device: DBus object path of the device * - * The #ValentBluezProfile::connection-opened signal is emitted when a Bluez - * socket for @device has been successfully wrapped in a #GSocketConnection + * The `ValentBluezProfile`::connection-opened signal is emitted when a Bluez + * socket for @device has been successfully wrapped in a `GSocketConnection` * and is ready for protocol negotiation. */ signals [CONNECTION_OPENED] = @@ -278,10 +278,10 @@ valent_bluez_profile_class_init (ValentBluezProfileClass *klass) { /** * ValentBluezProfile::connection-closed: - * @profile: a #ValentBluezProfile + * @profile: a `ValentBluezProfile` * @device: DBus object path of the device * - * The #ValentBluezProfile::connection-closed signal is emitted when a Bluez + * The `ValentBluezProfile`::connection-closed signal is emitted when a Bluez * socket for @device has been closed and should be cleaned up. */ signals [CONNECTION_CLOSED] = @@ -347,10 +347,10 @@ profile_manager_register_profile_cb (GDBusConnection *connection, /** * valent_bluez_profile_register: - * @profile: a #ValentBluezProfile - * @connection: a #GDBusConnection - * @cancellable: (nullable): a #GCancellable - * @callback: (scope async): a #GAsyncReadyCallback + * @profile: a `ValentBluezProfile` + * @connection: a `GDBusConnection` + * @cancellable: (nullable): a `GCancellable` + * @callback: (scope async): a `GAsyncReadyCallback` * @user_data: (closure): user supplied data * * Export the bluez profile for Valent on @connection and register it with the @@ -410,9 +410,9 @@ valent_bluez_profile_register (ValentBluezProfile *profile, /** * valent_bluez_profile_register_finish: - * @profile: a #ValentBluezProfile - * @result: a #GAsyncResult - * @error: (nullable): a #GError + * @profile: a `ValentBluezProfile` + * @result: a `GAsyncResult` + * @error: (nullable): a `GError` * * Finish an operation started with valent_bluez_profile_register(). * @@ -433,7 +433,7 @@ valent_bluez_profile_register_finish (ValentBluezProfile *profile, /** * valent_bluez_profile_unregister: - * @profile: a #ValentBluezProfile + * @profile: a `ValentBluezProfile` * * Unexport the bluez profile for Valent from the system bus. */ diff --git a/src/plugins/bluez/valent-mux-connection.c b/src/plugins/bluez/valent-mux-connection.c index ceb6a318f5..e6c774d9d0 100644 --- a/src/plugins/bluez/valent-mux-connection.c +++ b/src/plugins/bluez/valent-mux-connection.c @@ -75,20 +75,20 @@ typedef enum * ChannelState: * @uuid: the channel UUID * @mutex: a lock for changes to the state - * @stream: a #GIOStream + * @stream: a `GIOStream` * @buf: an input buffer * @len: size of the input buffer * @pos: data start * @end: data end * @read_free: free space in the input buffer - * @read_cond: a #GCond triggered when data can be read + * @read_cond: a `GCond` triggered when data can be read * @write_free: amount of bytes that can be written - * @write_cond: a #GCond triggered when data can be written + * @write_cond: a `GCond` triggered when data can be written * * A thread-safe info struct to track the state of a multiplex channel. * - * Each virtual multiplex channel is tracked by the real #ValentMuxConnection as - * a #ChannelState. + * Each virtual multiplex channel is tracked by the real `ValentMuxConnection` as + * a `ChannelState`. */ typedef struct { @@ -251,7 +251,7 @@ G_DEFINE_AUTOPTR_CLEANUP_FUNC (ChannelState, channel_state_unref) /** * pack_header: * @hdr: (out): a 19-byte buffer - * @type: a #MessageType type + * @type: a `MessageType` type * @size: size of the message data * @uuid: channel UUID * @@ -279,7 +279,7 @@ pack_header (uint8_t *hdr, /** * unpack_header: * @hdr: a 19-byte buffer - * @type: (out): a #MessageType type + * @type: (out): a `MessageType` type * @size: (out): size of the message data * @uuid: (out): a 37-byte buffer * @@ -850,7 +850,7 @@ valent_mux_connection_class_init (ValentMuxConnectionClass *klass) /** * ValentMuxConnection:base-stream: * - * The "base-stream" property is the #GIOStream being wrapped. + * The "base-stream" property is the `GIOStream` being wrapped. */ properties [PROP_BASE_STREAM] = g_param_spec_object ("base-stream", NULL, NULL, @@ -895,9 +895,9 @@ valent_mux_connection_init (ValentMuxConnection *self) * valent_mux_connection_new: * @base_stream: (not nullable): The base stream to wrap * - * Construct a new #ValentMuxConnection for @base_stream. + * Construct a new `ValentMuxConnection` for @base_stream. * - * Returns: (transfer full): a #ValentMuxConnection + * Returns: (transfer full): a `ValentMuxConnection` */ ValentMuxConnection * valent_mux_connection_new (GIOStream *base_stream) @@ -910,16 +910,16 @@ valent_mux_connection_new (GIOStream *base_stream) /** * valent_mux_connection_handshake: - * @connection: a #ValentMuxConnection - * @identity: a #JsonNode - * @cancellable: (nullable): a #GCancellable - * @error: (nullable): a #GError + * @connection: a `ValentMuxConnection` + * @identity: a `JsonNode` + * @cancellable: (nullable): a `GCancellable` + * @error: (nullable): a `GError` * * Attempt to negotiate a multiplex channel on @connection. This is a two-part * process involving negotiating the protocol version (currently only version 1) * and exchanging identity packets. * - * Returns: (transfer full): a #ValentChannel + * Returns: (transfer full): a `ValentChannel` */ ValentChannel * valent_mux_connection_handshake (ValentMuxConnection *connection, @@ -1024,9 +1024,9 @@ valent_mux_connection_handshake_task (GTask *task, /** * valent_mux_connection_handshake_async: - * @connection: a #ValentMuxConnection - * @cancellable: (nullable): a #GCancellable - * @callback: (scope async): a #GAsyncReadyCallback + * @connection: a `ValentMuxConnection` + * @cancellable: (nullable): a `GCancellable` + * @callback: (scope async): a `GAsyncReadyCallback` * @user_data: (closure): user supplied data * * This is the asynchronous version of valent_mux_connection_handshake(). @@ -1054,13 +1054,13 @@ valent_mux_connection_handshake_async (ValentMuxConnection *connection, /** * valent_mux_connection_handshake_finish: - * @connection: a #ValentMuxConnection - * @result: a #GAsyncResult - * @error: (nullable): a #GError + * @connection: a `ValentMuxConnection` + * @result: a `GAsyncResult` + * @error: (nullable): a `GError` * * Finishes an operation started by valent_mux_connection_handshake_async(). * - * Returns: (transfer full): a #ValentChannel + * Returns: (transfer full): a `ValentChannel` */ ValentChannel * valent_mux_connection_handshake_finish (ValentMuxConnection *connection, @@ -1076,14 +1076,14 @@ valent_mux_connection_handshake_finish (ValentMuxConnection *connection, /** * valent_mux_connection_accept_channel: - * @connection: a #ValentMuxConnection + * @connection: a `ValentMuxConnection` * @uuid: a channel UUID - * @cancellable: (nullable): a #GCancellable - * @error: (nullable): a #GError + * @cancellable: (nullable): a `GCancellable` + * @error: (nullable): a `GError` * * Blocks waiting for a channel to be opened for @uuid. * - * Returns: (transfer full): a #GIOStream + * Returns: (transfer full): a `GIOStream` */ GIOStream * valent_mux_connection_accept_channel (ValentMuxConnection *connection, @@ -1118,9 +1118,9 @@ valent_mux_connection_accept_channel (ValentMuxConnection *connection, /** * valent_mux_connection_close: - * @connection: a #ValentMuxConnection - * @cancellable: (nullable): a #GCancellable - * @error: (nullable): a #GError + * @connection: a `ValentMuxConnection` + * @cancellable: (nullable): a `GCancellable` + * @error: (nullable): a `GError` * * Close the multiplex connection. * @@ -1141,10 +1141,10 @@ valent_mux_connection_close (ValentMuxConnection *connection, /** * valent_mux_connection_close_channel: - * @connection: a #ValentMuxConnection + * @connection: a `ValentMuxConnection` * @uuid: a channel UUID - * @cancellable: (nullable): a #GCancellable - * @error: (nullable): a #GError + * @cancellable: (nullable): a `GCancellable` + * @error: (nullable): a `GError` * * Get the multiplex protocol version used by @connection. * @@ -1174,14 +1174,14 @@ valent_mux_connection_close_channel (ValentMuxConnection *connection, /** * valent_mux_connection_open_channel: - * @connection: a #ValentMuxConnection + * @connection: a `ValentMuxConnection` * @uuid: a channel UUID - * @cancellable: (nullable): a #GCancellable - * @error: (nullable): a #GError + * @cancellable: (nullable): a `GCancellable` + * @error: (nullable): a `GError` * * Attempt to open a muxed channel for @uuid. * - * Returns: (transfer full): a #GIOStream + * Returns: (transfer full): a `GIOStream` */ GIOStream * valent_mux_connection_open_channel (ValentMuxConnection *connection, @@ -1229,17 +1229,17 @@ valent_mux_connection_open_channel (ValentMuxConnection *connection, /** * valent_mux_connection_read: - * @connection: a #ValentMuxConnection + * @connection: a `ValentMuxConnection` * @uuid: a channel UUID * @buffer: a buffer to read data into * @count: the number of bytes that will be read from the stream - * @cancellable: (nullable): a #GCancellable - * @error: (nullable): a #GError + * @cancellable: (nullable): a `GCancellable` + * @error: (nullable): a `GError` * * Tries to read count bytes from the channel @uuid into the buffer starting at * @buffer. Will block during this read. * - * This is used by #ValentMuxInputStream to implement g_input_stream_read(). + * This is used by `ValentMuxInputStream` to implement g_input_stream_read(). * * Returns: number of bytes read, or -1 on error, or 0 on end of file */ @@ -1317,17 +1317,17 @@ valent_mux_connection_read (ValentMuxConnection *connection, /** * valent_mux_connection_write: - * @connection: a #ValentMuxConnection + * @connection: a `ValentMuxConnection` * @uuid: a channel UUID * @buffer: data to write * @count: size of the write - * @cancellable: (nullable): a #GCancellable - * @error: (nullable): a #GError + * @cancellable: (nullable): a `GCancellable` + * @error: (nullable): a `GError` * * Tries to write @count bytes from @buffer into the stream for @uuid. Will * block during the operation. * - * This is used by #ValentMuxOutputStream to implement g_output_stream_write(). + * This is used by `ValentMuxOutputStream` to implement g_output_stream_write(). * * Returns: number of bytes written, or -1 with @error set */ diff --git a/src/plugins/bluez/valent-mux-io-stream.c b/src/plugins/bluez/valent-mux-io-stream.c index 65e9e2bef8..25e38b978b 100644 --- a/src/plugins/bluez/valent-mux-io-stream.c +++ b/src/plugins/bluez/valent-mux-io-stream.c @@ -223,12 +223,12 @@ valent_mux_io_stream_init (ValentMuxIOStream *self) /** * valent_mux_io_stream_new: - * @muxer: a #ValentMuxConnection + * @muxer: a `ValentMuxConnection` * @uuid: a UUID * - * Creates a new #ValentMuxIOStream for @uuid, muxed by @muxer. + * Creates a new `ValentMuxIOStream` for @uuid, muxed by @muxer. * - * Returns: (transfer full): a new #ValentMuxIOStream + * Returns: (transfer full): a new `ValentMuxIOStream` */ GIOStream * valent_mux_io_stream_new (ValentMuxConnection *muxer, @@ -245,7 +245,7 @@ valent_mux_io_stream_new (ValentMuxConnection *muxer, /** * valent_mux_io_stream_get_uuid: - * @stream: a #ValentMuxIOStream + * @stream: a `ValentMuxIOStream` * * Get the UUID for @stream. * diff --git a/src/plugins/connectivity_report/valent-telephony.c b/src/plugins/connectivity_report/valent-telephony.c index bf3da60758..e8af010038 100644 --- a/src/plugins/connectivity_report/valent-telephony.c +++ b/src/plugins/connectivity_report/valent-telephony.c @@ -17,7 +17,7 @@ * * A class for controlling pointer and keyboard devices. * - * #ValentTelephony is an abstraction of telephony support, intended for use by + * `ValentTelephony` is an abstraction of telephony support, intended for use by * [class@Valent.DevicePlugin] implementations. */ @@ -327,9 +327,9 @@ valent_telephony_class_init (ValentTelephonyClass *klass) /** * ValentTelephony::changed: - * @self: a #ValentTelephony + * @self: a `ValentTelephony` * - * #ValentTelephony::changed is emitted whenever a relevant property changes. + * `ValentTelephony`::changed is emitted whenever a relevant property changes. */ signals [CHANGED] = g_signal_new ("changed", @@ -354,7 +354,7 @@ valent_telephony_init (ValentTelephony *self) * * Get the default [class@Valent.Network]. * - * Returns: (transfer none) (not nullable): a #ValentTelephony + * Returns: (transfer none) (not nullable): a `ValentTelephony` * * Since: 1.0 */ @@ -419,11 +419,11 @@ valent_telephony_serialize_modem (GDBusProxy *proxy) /** * valent_telephony_get_signal_strengths: - * @telephony: a #ValentTelephony + * @telephony: a `ValentTelephony` * * Get a serialized dictionary of the known modems' status. * - * Returns: (transfer full) (nullable): a #JsonNode + * Returns: (transfer full) (nullable): a `JsonNode` * * Since: 1.0 */ diff --git a/src/plugins/eds/valent-eds-utils.c b/src/plugins/eds/valent-eds-utils.c index dbb9d84de6..b9e40f08d3 100644 --- a/src/plugins/eds/valent-eds-utils.c +++ b/src/plugins/eds/valent-eds-utils.c @@ -14,12 +14,12 @@ static ESourceRegistry *default_registry = NULL; /** * valent_eds_get_registry: - * @cancellable: (nullable): a #GCancellable - * @error: (nullable): a #GError + * @cancellable: (nullable): a `GCancellable` + * @error: (nullable): a `GError` * - * Get the global #ESourceRegistry object. + * Get the global `ESourceRegistry` object. * - * Returns: (transfer none): the #ESourceRegistry + * Returns: (transfer none): the `ESourceRegistry` */ ESourceRegistry * valent_eds_get_registry (GCancellable *cancellable, @@ -40,16 +40,16 @@ valent_eds_get_registry (GCancellable *cancellable, /** * valent_eds_register_source: - * @source: an #ESource - * @cancellable: (nullable): a #GCancellable - * @error: (nullable): a #GError + * @source: an `ESource` + * @cancellable: (nullable): a `GCancellable` + * @error: (nullable): a `GError` * - * Register @scratch with the #ESourceRegistry. If a source with the same UID as + * Register @scratch with the `ESourceRegistry`. If a source with the same UID as * @scratch is already registered, that source will be returned. If the registry * is unavailable or registration fails a new reference of @scratch will be * returned. * - * Returns: (transfer full): an #ESource + * Returns: (transfer full): an `ESource` */ ESource * valent_eds_register_source (ESource *scratch, diff --git a/src/plugins/findmyphone/valent-findmyphone-ringer.c b/src/plugins/findmyphone/valent-findmyphone-ringer.c index 8245c7a10c..7229368f74 100644 --- a/src/plugins/findmyphone/valent-findmyphone-ringer.c +++ b/src/plugins/findmyphone/valent-findmyphone-ringer.c @@ -87,9 +87,9 @@ valent_findmyphone_ringer_free (gpointer data) /** * valent_findmyphone_ringer_new: * - * Create a new #ValentFindmyphoneRinger. + * Create a new `ValentFindmyphoneRinger`. * - * Returns: (transfer full): a #ValentFindmyphoneRinger + * Returns: (transfer full): a `ValentFindmyphoneRinger` */ ValentFindmyphoneRinger * valent_findmyphone_ringer_new (void) @@ -120,7 +120,7 @@ valent_findmyphone_ringer_new (void) /** * valent_findmyphone_ringer_start: - * @ringer: a #ValentFindmyphoneRinger + * @ringer: a `ValentFindmyphoneRinger` * * Enable the ringing state of @ringer. */ @@ -143,7 +143,7 @@ valent_findmyphone_ringer_start (ValentFindmyphoneRinger *ringer) /** * valent_findmyphone_ringer_stop: - * @ringer: a #ValentFindmyphoneRinger + * @ringer: a `ValentFindmyphoneRinger` * * Disable the ringing state of @ringer. */ @@ -162,7 +162,7 @@ valent_findmyphone_ringer_stop (ValentFindmyphoneRinger *ringer) /** * valent_findmyphone_ringer_show: - * @ringer: a #ValentFindmyphoneRinger + * @ringer: a `ValentFindmyphoneRinger` * * Enable the ringing state of @ringer and show a dialog. */ @@ -226,7 +226,7 @@ valent_findmyphone_ringer_show (ValentFindmyphoneRinger *ringer) /** * valent_findmyphone_ringer_hide: - * @ringer: a #ValentFindmyphoneRinger + * @ringer: a `ValentFindmyphoneRinger` * * Disable the ringing state of @ringer and hide the dialog. */ @@ -244,9 +244,9 @@ valent_findmyphone_ringer_hide (ValentFindmyphoneRinger *ringer) /** * valent_findmyphone_ringer_acquire: * - * Acquire a reference on the default #ValentFindmyphoneRinger. + * Acquire a reference on the default `ValentFindmyphoneRinger`. * - * Returns: (transfer full): a #ValentFindmyphoneRinger + * Returns: (transfer full): a `ValentFindmyphoneRinger` */ ValentFindmyphoneRinger * valent_findmyphone_ringer_acquire (void) @@ -262,9 +262,9 @@ valent_findmyphone_ringer_acquire (void) /** * valent_findmyphone_ringer_release: - * @data: (type Valent.FindmyphoneRinger): a #ValentFindmyphoneRinger + * @data: (type Valent.FindmyphoneRinger): a `ValentFindmyphoneRinger` * - * Release a reference on the default #ValentFindmyphoneRinger. + * Release a reference on the default `ValentFindmyphoneRinger`. */ void valent_findmyphone_ringer_release (gpointer data) @@ -278,8 +278,8 @@ valent_findmyphone_ringer_release (gpointer data) /** * valent_findmyphone_ringer_toggle: - * @ringer: a #ValentFindmyphoneRinger - * @owner: (type GObject.Object): a #GObject + * @ringer: a `ValentFindmyphoneRinger` + * @owner: (type GObject.Object): a `GObject` * * Toggle the ringing state of @ringer. */ @@ -303,8 +303,8 @@ valent_findmyphone_ringer_toggle (ValentFindmyphoneRinger *ringer, /** * valent_findmyphone_ringer_is_owner: - * @ringer: a #ValentFindmyphoneRinger - * @owner: (type GObject.Object): a #GObject + * @ringer: a `ValentFindmyphoneRinger` + * @owner: (type GObject.Object): a `GObject` * * Check if @owner is responsible for the current state of @ringer. * diff --git a/src/plugins/lan/valent-lan-channel-service.c b/src/plugins/lan/valent-lan-channel-service.c index b0bf169362..34adaefde1 100644 --- a/src/plugins/lan/valent-lan-channel-service.c +++ b/src/plugins/lan/valent-lan-channel-service.c @@ -85,9 +85,9 @@ on_channel_destroyed (ValentLanChannelService *self, /** * valent_lan_channel_service_verify_channel: - * @self: a #ValentLanChannelService + * @self: a `ValentLanChannelService` * @identity: a KDE Connect identity packet - * @connection: a #GTlsConnection + * @connection: a `GTlsConnection` * * Verify an encrypted TLS connection. * @@ -280,8 +280,8 @@ on_incoming_connection (ValentChannelService *service, /** * valent_lan_channel_service_tcp_setup: - * @self: a #ValentLanChannelService - * @error: (nullable): a #GError + * @self: a `ValentLanChannelService` + * @error: (nullable): a `GError` * * A wrapper around g_socket_listener_add_inet_port() that can be called * multiple times. @@ -696,9 +696,9 @@ on_items_changed (GListModel *list, /** * valent_lan_channel_service_udp_setup: - * @self: a #ValentLanChannelService - * @cancellable: (nullable): a #GCancellable - * @error: (nullable): a #GError + * @self: a `ValentLanChannelService` + * @cancellable: (nullable): a `GCancellable` + * @error: (nullable): a `GError` * * An analog to valent_lan_channel_service_tcp_setup() that prepares UDP sockets * for IPv4 and IPv6, including streams for reading. diff --git a/src/plugins/lan/valent-lan-channel.c b/src/plugins/lan/valent-lan-channel.c index 46fcb678a6..3e800f9829 100644 --- a/src/plugins/lan/valent-lan-channel.c +++ b/src/plugins/lan/valent-lan-channel.c @@ -400,11 +400,11 @@ valent_lan_channel_init (ValentLanChannel *self) /** * valent_lan_channel_ref_certificate: - * @self: a #ValentLanChannel + * @self: a `ValentLanChannel` * * Get the TLS certificate. * - * Returns: (transfer full) (nullable): a #GTlsCertificate + * Returns: (transfer full) (nullable): a `GTlsCertificate` */ GTlsCertificate * valent_lan_channel_ref_certificate (ValentLanChannel *self) @@ -424,11 +424,11 @@ valent_lan_channel_ref_certificate (ValentLanChannel *self) /** * valent_lan_channel_ref_peer_certificate: - * @self: a #ValentLanChannel + * @self: a `ValentLanChannel` * * Get the peer TLS certificate. * - * Returns: (transfer full) (nullable): a #GTlsCertificate + * Returns: (transfer full) (nullable): a `GTlsCertificate` */ GTlsCertificate * valent_lan_channel_ref_peer_certificate (ValentLanChannel *self) @@ -448,7 +448,7 @@ valent_lan_channel_ref_peer_certificate (ValentLanChannel *self) /** * valent_lan_channel_dup_host: - * @self: a #ValentLanChannel + * @self: a `ValentLanChannel` * * Get the host address. * @@ -470,7 +470,7 @@ valent_lan_channel_dup_host (ValentLanChannel *self) /** * valent_lan_channel_get_port: - * @self: a #ValentLanChannel + * @self: a `ValentLanChannel` * * Get the host port. * diff --git a/src/plugins/lan/valent-lan-utils.c b/src/plugins/lan/valent-lan-utils.c index ff1150e3a8..8ee1336bc8 100644 --- a/src/plugins/lan/valent-lan-utils.c +++ b/src/plugins/lan/valent-lan-utils.c @@ -14,7 +14,7 @@ /* < private > * valent_lan_configure_socket: - * @connection: a #GSocketConnection + * @connection: a `GSocketConnection` * * Configure TCP socket options as they are set in kdeconnect-kde. * @@ -58,7 +58,7 @@ valent_lan_configure_socket (GSocketConnection *connection) /* * The KDE Connect protocol follows a trust-on-first-use approach to TLS, so we - * use a dummy callback for #GTlsConnection::accept-certificate that always + * use a dummy callback for `GTlsConnection`::accept-certificate that always * returns %TRUE. */ static gboolean @@ -91,10 +91,10 @@ valent_lan_accept_certificate (GTlsConnection *connection, /* < private > * valent_lan_handshake_certificate: - * @connection: a #GTlsConnection - * @trusted: a #GTlsCertificate - * @cancellable: (nullable): a #GCancellable - * @error: (nullable): a #GError + * @connection: a `GTlsConnection` + * @trusted: a `GTlsCertificate` + * @cancellable: (nullable): a `GCancellable` + * @error: (nullable): a `GError` * * Authenticate a connection for a known peer. * @@ -131,9 +131,9 @@ valent_lan_handshake_certificate (GTlsConnection *connection, /* < private > * valent_lan_handshake_peer: - * @connection: a #GTlsConnection - * @cancellable: (nullable): a #GCancellable - * @error: (nullable): a #GError + * @connection: a `GTlsConnection` + * @cancellable: (nullable): a `GCancellable` + * @error: (nullable): a `GError` * * Authenticate a connection for an unknown peer. * @@ -199,10 +199,10 @@ valent_lan_handshake_peer (GTlsConnection *connection, /** * valent_lan_encrypt_client_connection: - * @connection: a #GSocketConnection - * @certificate: a #GTlsCertificate - * @cancellable: (nullable): a #GCancellable - * @error: (nullable): a #GError + * @connection: a `GSocketConnection` + * @certificate: a `GTlsCertificate` + * @cancellable: (nullable): a `GCancellable` + * @error: (nullable): a `GError` * * Authenticate and encrypt a client connection. * @@ -213,7 +213,7 @@ valent_lan_handshake_peer (GTlsConnection *connection, * device ID to check for a trusted certificate. For auxiliary connections * created from an existing channel, use [func@Valent.lan_encrypt_client]. * - * Returns: (transfer full) (nullable): a TLS encrypted #GIOStream + * Returns: (transfer full) (nullable): a TLS encrypted `GIOStream` */ GIOStream * valent_lan_encrypt_client_connection (GSocketConnection *connection, @@ -259,18 +259,18 @@ valent_lan_encrypt_client_connection (GSocketConnection *connection, /** * valent_lan_encrypt_client: - * @connection: a #GSocketConnection - * @certificate: a #GTlsCertificate - * @peer_certificate: a #GTlsCertificate - * @cancellable: (nullable): a #GCancellable - * @error: (nullable): a #GError + * @connection: a `GSocketConnection` + * @certificate: a `GTlsCertificate` + * @peer_certificate: a `GTlsCertificate` + * @cancellable: (nullable): a `GCancellable` + * @error: (nullable): a `GError` * * Authenticate and encrypt an auxiliary client connection. * * This function sets the standard KDE Connect socket options on @connection, * wraps it in a [class@Gio.TlsConnection] and returns the result. * - * Returns: (transfer full) (nullable): a TLS encrypted #GIOStream + * Returns: (transfer full) (nullable): a TLS encrypted `GIOStream` */ GIOStream * valent_lan_encrypt_client (GSocketConnection *connection, @@ -331,10 +331,10 @@ valent_lan_encrypt_client (GSocketConnection *connection, /** * valent_lan_encrypt_server_connection: - * @connection: a #GSocketConnection - * @certificate: a #GTlsConnection - * @cancellable: (nullable): a #GCancellable - * @error: (nullable): a #GError + * @connection: a `GSocketConnection` + * @certificate: a `GTlsConnection` + * @cancellable: (nullable): a `GCancellable` + * @error: (nullable): a `GError` * * Authenticate and encrypt a server connection. * @@ -345,7 +345,7 @@ valent_lan_encrypt_client (GSocketConnection *connection, * device ID to check for a trusted certificate. For auxiliary connections * created from an existing channel, use [func@Valent.lan_encrypt_server]. * - * Returns: (transfer full) (nullable): a TLS encrypted #GIOStream + * Returns: (transfer full) (nullable): a TLS encrypted `GIOStream` */ GIOStream * valent_lan_encrypt_server_connection (GSocketConnection *connection, @@ -387,18 +387,18 @@ valent_lan_encrypt_server_connection (GSocketConnection *connection, /** * valent_lan_encrypt_server: - * @connection: a #GSocketConnection - * @certificate: a #GTlsCertificate - * @peer_certificate: a #GTlsCertificate - * @cancellable: (nullable): a #GCancellable - * @error: (nullable): a #GError + * @connection: a `GSocketConnection` + * @certificate: a `GTlsCertificate` + * @peer_certificate: a `GTlsCertificate` + * @cancellable: (nullable): a `GCancellable` + * @error: (nullable): a `GError` * * Authenticate and encrypt an auxiliary server connection. * * This function sets the standard KDE Connect socket options on @connection, * wraps it in a [class@Gio.TlsConnection] and returns the result. * - * Returns: (transfer full) (nullable): a TLS encrypted #GIOStream + * Returns: (transfer full) (nullable): a TLS encrypted `GIOStream` */ GIOStream * valent_lan_encrypt_server (GSocketConnection *connection, diff --git a/src/plugins/mousepad/valent-mousepad-device.c b/src/plugins/mousepad/valent-mousepad-device.c index 6a97b0c156..d5e6cd51cb 100644 --- a/src/plugins/mousepad/valent-mousepad-device.c +++ b/src/plugins/mousepad/valent-mousepad-device.c @@ -620,11 +620,11 @@ valent_mousepad_device_init (ValentMousepadDevice *self) /** * valent_mousepad_device_new: - * @device: a #ValentDevice + * @device: a `ValentDevice` * - * Get the #ValentMousepadDevice instance. + * Get the `ValentMousepadDevice` instance. * - * Returns: (transfer full) (nullable): a #ValentMousepadDevice + * Returns: (transfer full) (nullable): a `ValentMousepadDevice` */ ValentMousepadDevice * valent_mousepad_device_new (ValentDevice *device) @@ -636,7 +636,7 @@ valent_mousepad_device_new (ValentDevice *device) /** * valent_media_player_update_packet: - * @player: a #ValentMousepadDevice + * @player: a `ValentMousepadDevice` * @packet: a KDE Connect packet * * A convenience method for updating the internal state of the player from a diff --git a/src/plugins/mpris/valent-mpris-device.c b/src/plugins/mpris/valent-mpris-device.c index d26243f788..6e0ca62c31 100644 --- a/src/plugins/mpris/valent-mpris-device.c +++ b/src/plugins/mpris/valent-mpris-device.c @@ -580,11 +580,11 @@ valent_mpris_device_init (ValentMprisDevice *self) /** * valent_mpris_device_new: - * @device: a #ValentDevice + * @device: a `ValentDevice` * - * Get the #ValentMprisDevice instance. + * Get the `ValentMprisDevice` instance. * - * Returns: (transfer full) (nullable): a #ValentMprisDevice + * Returns: (transfer full) (nullable): a `ValentMprisDevice` */ ValentMprisDevice * valent_mpris_device_new (ValentDevice *device) @@ -596,7 +596,7 @@ valent_mpris_device_new (ValentDevice *device) /** * valent_media_player_update_packet: - * @player: a #ValentMprisDevice + * @player: a `ValentMprisDevice` * @packet: a KDE Connect packet * * A convenience method for updating the internal state of the player from a @@ -681,8 +681,8 @@ valent_mpris_device_handle_packet (ValentMprisDevice *player, /** * valent_mpris_device_update_art: - * @player: a #ValentMprisDevice - * @file: a #GFile + * @player: a `ValentMprisDevice` + * @file: a `GFile` * * Update the `mpris:artUrl` metadata field from @file. */ @@ -708,7 +708,7 @@ valent_mpris_device_update_art (ValentMprisDevice *player, /** * valent_media_player_update_name: - * @player: a #ValentMprisDevice + * @player: a `ValentMprisDevice` * @name: a name * * Set the user-visible name of the player to @identity. diff --git a/src/plugins/mpris/valent-mpris-impl.c b/src/plugins/mpris/valent-mpris-impl.c index d5c60d7c68..2e76b5e595 100644 --- a/src/plugins/mpris/valent-mpris-impl.c +++ b/src/plugins/mpris/valent-mpris-impl.c @@ -685,11 +685,11 @@ valent_mpris_impl_init (ValentMPRISImpl *self) /** * valent_mpris_impl_new: - * @player: a #ValentMediaPlayer + * @player: a `ValentMediaPlayer` * - * Get the #ValentMPRISImpl instance. + * Get the `ValentMPRISImpl` instance. * - * Returns: (transfer full) (nullable): a #ValentMPRISImpl + * Returns: (transfer full) (nullable): a `ValentMPRISImpl` */ ValentMPRISImpl * valent_mpris_impl_new (ValentMediaPlayer *player) @@ -703,8 +703,8 @@ valent_mpris_impl_new (ValentMediaPlayer *player) /** * valent_media_player_impl_export: - * @impl: a #ValentMPRISImpl - * @connection: a #GDBusConnection + * @impl: a `ValentMPRISImpl` + * @connection: a `GDBusConnection` * @error: * * Impl @impl on @connection. @@ -800,10 +800,10 @@ valent_mpris_impl_export_full_cb (GObject *object, /** * valent_mpris_impl_export_full: - * @impl: a #ValentMPRISImpl + * @impl: a `ValentMPRISImpl` * @bus_name: the well-known name to own - * @cancellable: (nullable): a #GCancellable - * @callback: (scope async): a #GAsyncReadyCallback + * @cancellable: (nullable): a `GCancellable` + * @callback: (scope async): a `GAsyncReadyCallback` * @user_data: (closure): user supplied data * * Impl the test media player on the session bus. @@ -848,9 +848,9 @@ valent_mpris_impl_export_full (ValentMPRISImpl *impl, /** * valent_mpris_impl_export_finish: - * @impl: a #ValentMPRISImpl - * @cancellable: (nullable): a #GCancellable - * @error: (nullable): a #GError + * @impl: a `ValentMPRISImpl` + * @cancellable: (nullable): a `GCancellable` + * @error: (nullable): a `GError` * * Finish an operation started by valent_mpris_impl_export_full(). * @@ -870,7 +870,7 @@ valent_mpris_impl_export_finish (ValentMPRISImpl *impl, /** * valent_mpris_player_impl_unexport: - * @impl: a #ValentMPRISImpl + * @impl: a `ValentMPRISImpl` * * Unexport the player. */ diff --git a/src/plugins/mpris/valent-mpris-utils.c b/src/plugins/mpris/valent-mpris-utils.c index 44a28233e6..ee2be10d56 100644 --- a/src/plugins/mpris/valent-mpris-utils.c +++ b/src/plugins/mpris/valent-mpris-utils.c @@ -91,9 +91,9 @@ valent_mpris_get_info (void) /** * valent_mpris_get_application_iface: * - * Get a #GDBusInterfaceInfo for the `org.mpris.MediaPlayer2` interface. + * Get a `GDBusInterfaceInfo` for the `org.mpris.MediaPlayer2` interface. * - * Returns: (transfer none): a #GDBusInterfaceInfo + * Returns: (transfer none): a `GDBusInterfaceInfo` */ GDBusInterfaceInfo * valent_mpris_get_application_iface (void) @@ -106,9 +106,9 @@ valent_mpris_get_application_iface (void) /** * valent_mpris_get_player_iface: * - * Get a #GDBusInterfaceInfo for the `org.mpris.MediaPlayer2.Player` interface. + * Get a `GDBusInterfaceInfo` for the `org.mpris.MediaPlayer2.Player` interface. * - * Returns: (transfer none): a #GDBusInterfaceInfo + * Returns: (transfer none): a `GDBusInterfaceInfo` */ GDBusInterfaceInfo * valent_mpris_get_player_iface (void) @@ -122,7 +122,7 @@ valent_mpris_get_player_iface (void) * valent_mpris_repeat_from_string: * @loop_status: repeat mode to translate * - * Translate an MPRIS `LoopStatus` string to a #ValentMediaRepeat. + * Translate an MPRIS `LoopStatus` string to a `ValentMediaRepeat`. * * Returns: (transfer none): a repeat mode */ @@ -147,7 +147,7 @@ valent_mpris_repeat_from_string (const char *loop_status) * valent_mpris_repeat_to_string: * @repeat: repeat mode to translate * - * Translate a #ValentMediaRepeat enum to an MPRIS `LoopStatus` string. + * Translate a `ValentMediaRepeat` enum to an MPRIS `LoopStatus` string. * * Returns: (transfer none): a status string */ @@ -172,7 +172,7 @@ valent_mpris_repeat_to_string (ValentMediaRepeat repeat) * valent_mpris_state_from_string: * @playback_status: playback mode to translate * - * Translate an MPRIS `PlaybackStatus` string to a #ValentMediaState. + * Translate an MPRIS `PlaybackStatus` string to a `ValentMediaState`. * * Returns: (transfer none): a playback state */ @@ -197,7 +197,7 @@ valent_mpris_state_from_string (const char *playback_status) * valent_mpris_state_to_string: * @state: playback mode to translate * - * Translate a #ValentMediaState enum to an MPRIS `PlaybackStatus` string. + * Translate a `ValentMediaState` enum to an MPRIS `PlaybackStatus` string. * * Returns: (transfer none): a status string */ diff --git a/src/plugins/mpris/valent-mpris-utils.h b/src/plugins/mpris/valent-mpris-utils.h index 102ec17caa..f850d9f691 100644 --- a/src/plugins/mpris/valent-mpris-utils.h +++ b/src/plugins/mpris/valent-mpris-utils.h @@ -17,15 +17,14 @@ G_BEGIN_DECLS /** * VALENT_MPRIS_APPLICATION_INFO: * - * A #GDBusInterfaceInfo describing the `org.mpris.MediaPlayer2` interface. + * A [type@Gio.DBusInterfaceInfo] for `org.mpris.MediaPlayer2`. */ #define VALENT_MPRIS_APPLICATION_INFO (valent_mpris_get_application_iface()) /** * VALENT_MPRIS_PLAYER_INFO: * - * A #GDBusInterfaceInfo describing the `org.mpris.MediaPlayer2.Player` - * interface. + * A [type@Gio.DBusInterfaceInfo] for `org.mpris.MediaPlayer2.Player`. */ #define VALENT_MPRIS_PLAYER_INFO (valent_mpris_get_player_iface()) diff --git a/src/plugins/notification/valent-notification-dialog.c b/src/plugins/notification/valent-notification-dialog.c index 8da214dea5..3eeaa6b165 100644 --- a/src/plugins/notification/valent-notification-dialog.c +++ b/src/plugins/notification/valent-notification-dialog.c @@ -371,11 +371,11 @@ valent_notification_dialog_init (ValentNotificationDialog *self) /** * valent_notification_dialog_get_notification: - * @dialog: a #ValentNotificationDialog + * @dialog: a `ValentNotificationDialog` * * Get the notification. * - * Returns: (transfer none): a #ValentNotification + * Returns: (transfer none): a `ValentNotification` */ ValentNotification * valent_notification_dialog_get_notification (ValentNotificationDialog *dialog) @@ -387,7 +387,7 @@ valent_notification_dialog_get_notification (ValentNotificationDialog *dialog) /** * valent_notification_dialog_get_reply_id: (get-property reply-id) - * @dialog: a #ValentNotificationDialog + * @dialog: a `ValentNotificationDialog` * * Get the notification reply ID. * @@ -403,7 +403,7 @@ valent_notification_dialog_get_reply_id (ValentNotificationDialog *dialog) /** * valent_notification_dialog_set_reply_id: (set-property reply-id) - * @dialog: a #ValentNotificationDialog + * @dialog: a `ValentNotificationDialog` * @reply_id: (nullable): a notification reply ID * * Set the notification reply ID. diff --git a/src/plugins/notification/valent-notification-plugin.c b/src/plugins/notification/valent-notification-plugin.c index 7b3b4bb343..522859c959 100644 --- a/src/plugins/notification/valent-notification-plugin.c +++ b/src/plugins/notification/valent-notification-plugin.c @@ -695,12 +695,12 @@ valent_notification_plugin_send_notification_with_icon (ValentNotificationPlugin /** * valent_notification_plugin_send_notification: - * @self: a #ValentNotificationPlugin + * @self: a `ValentNotificationPlugin` * @id: the notification id * @appName: (nullable): the notifying application * @title: (nullable): the notification title * @body: (nullable): the notification body - * @icon: (nullable): a #GIcon + * @icon: (nullable): a `GIcon` * * Send a notification to the remote device. */ diff --git a/src/plugins/notification/valent-notification-upload.c b/src/plugins/notification/valent-notification-upload.c index 28828648b1..bf3db264df 100644 --- a/src/plugins/notification/valent-notification-upload.c +++ b/src/plugins/notification/valent-notification-upload.c @@ -20,8 +20,8 @@ * * A class for notification icon uploads. * - * #ValentNotificationUpload is a class that abstracts uploading notifications - * with icon payloads for #ValentNotificationPlugin. + * `ValentNotificationUpload` is a class that abstracts uploading notifications + * with icon payloads for `ValentNotificationPlugin`. */ struct _ValentNotificationUpload @@ -486,13 +486,13 @@ valent_notification_upload_init (ValentNotificationUpload *self) /** * valent_notification_upload_new: - * @device: a #ValentDevice + * @device: a `ValentDevice` * @packet: a KDE Connect packet - * @icon: a #GIcon + * @icon: a `GIcon` * - * Create a new #ValentNotificationUpload for @packet and @icon. + * Create a new `ValentNotificationUpload` for @packet and @icon. * - * Returns: (transfer full): a #ValentNotificationUpload + * Returns: (transfer full): a `ValentNotificationUpload` */ ValentTransfer * valent_notification_upload_new (ValentDevice *device, diff --git a/src/plugins/pulseaudio/valent-pa-stream.c b/src/plugins/pulseaudio/valent-pa-stream.c index f3e8c3b6df..fdb6d370ee 100644 --- a/src/plugins/pulseaudio/valent-pa-stream.c +++ b/src/plugins/pulseaudio/valent-pa-stream.c @@ -243,7 +243,7 @@ valent_pa_stream_class_init (ValentPaStreamClass *klass) /** * ValentPaStream:base-stream: * - * The #GvcMixerStream this stream wraps. + * The `GvcMixerStream` this stream wraps. */ properties [PROP_BASE_STREAM] = g_param_spec_object ("base-stream", NULL, NULL, diff --git a/src/plugins/runcommand/valent-runcommand-editor.c b/src/plugins/runcommand/valent-runcommand-editor.c index f5b02eaa6f..53038f842d 100644 --- a/src/plugins/runcommand/valent-runcommand-editor.c +++ b/src/plugins/runcommand/valent-runcommand-editor.c @@ -275,7 +275,7 @@ valent_runcommand_editor_init (ValentRuncommandEditor *self) /** * valent_runcommand_editor_get_command: - * @editor: a #ValentRuncommandEditor + * @editor: a `ValentRuncommandEditor` * * Get the command the editor is operating on. * @@ -291,7 +291,7 @@ valent_runcommand_editor_get_command (ValentRuncommandEditor *editor) /** * valent_runcommand_editor_set_command: - * @editor: a #ValentRuncommandEditor + * @editor: a `ValentRuncommandEditor` * @command: a command entry * * Set the command for the editor to operate on. @@ -313,7 +313,7 @@ valent_runcommand_editor_set_command (ValentRuncommandEditor *editor, /** * valent_runcommand_editor_get_uuid: - * @editor: a #ValentRuncommandEditor + * @editor: a `ValentRuncommandEditor` * * Get the UUID of the command for @editor * @@ -329,7 +329,7 @@ valent_runcommand_editor_get_uuid (ValentRuncommandEditor *editor) /** * valent_runcommand_editor_set_uuid: - * @editor: a #ValentRuncommandEditor + * @editor: a `ValentRuncommandEditor` * @uuid: a command UUID * * Set the UUID of the command for @editor to @uuid. diff --git a/src/plugins/sftp/valent-sftp-plugin.c b/src/plugins/sftp/valent-sftp-plugin.c index ef54fef914..1cf3d1342d 100644 --- a/src/plugins/sftp/valent-sftp-plugin.c +++ b/src/plugins/sftp/valent-sftp-plugin.c @@ -54,9 +54,9 @@ get_device_host (ValentSftpPlugin *self) * @port: Port * @username: Username (deprecated) * @password: Password (deprecated) - * @mount: A #GMount for the session + * @mount: A `GMount` for the session * - * #ValentSftpSession is a simple representation of a SFTP session. + * `ValentSftpSession` is a simple representation of a SFTP session. */ typedef struct _ValentSftpSession { @@ -259,7 +259,7 @@ on_mount_removed (GVolumeMonitor *volume_monitor, * avoid password authentication if possible. * * All host keys are accepted since we connect to known hosts as communicated - * over the TLS encrypted #ValentLanChannel. + * over the TLS encrypted `ValentLanChannel`. */ static void ask_password_cb (GMountOperation *op, diff --git a/src/plugins/share/valent-share-download.c b/src/plugins/share/valent-share-download.c index e30fb2219d..0fafd5088d 100644 --- a/src/plugins/share/valent-share-download.c +++ b/src/plugins/share/valent-share-download.c @@ -23,8 +23,8 @@ * * A class for multi-file downloads. * - * #ValentShareDownload is a class that supports multi-file downloads for - * #ValentSharePlugin. + * `ValentShareDownload` is a class that supports multi-file downloads for + * `ValentSharePlugin`. */ struct _ValentShareDownload @@ -293,11 +293,11 @@ valent_share_download_init (ValentShareDownload *self) /** * valent_share_download_new: - * @device: a #ValentDevice + * @device: a `ValentDevice` * - * Create a new #ValentShareDownload. + * Create a new `ValentShareDownload`. * - * Returns: (transfer full): a new #ValentShareDownload + * Returns: (transfer full): a new `ValentShareDownload` */ ValentTransfer * valent_share_download_new (ValentDevice *device) @@ -311,8 +311,8 @@ valent_share_download_new (ValentDevice *device) /** * valent_share_download_add_file: - * @group: a #ValentShareDownload - * @file: a #GFile + * @group: a `ValentShareDownload` + * @file: a `GFile` * @packet: a KDE Connect packet * * Add @file to the transfer operation. @@ -353,7 +353,7 @@ valent_share_download_add_file (ValentShareDownload *download, /** * valent_share_download_update: - * @download: a #ValentShareDownload + * @download: a `ValentShareDownload` * @packet: a KDE Connect packet * * Update the number of files and total payload size for @download. diff --git a/src/plugins/share/valent-share-plugin.c b/src/plugins/share/valent-share-plugin.c index 2eb00527ae..1a91155f91 100644 --- a/src/plugins/share/valent-share-plugin.c +++ b/src/plugins/share/valent-share-plugin.c @@ -648,7 +648,7 @@ gtk_file_dialog_open_multiple_cb (GtkFileDialog *dialog, * @parameter: %NULL * * The default share action opens the platform-specific dialog for selecting - * files, typically a #GtkFileChooserDialog. + * files, typically a `GtkFileChooserDialog`. */ static void share_chooser_action (GSimpleAction *action, @@ -857,7 +857,7 @@ share_uri_action (GSimpleAction *action, * @uris: a list of URIs * * This action is a convenience for sending multiple URIs, as with the - * `ValentSharePlugin|share.uri` #GAction. + * `ValentSharePlugin|share.uri` `GAction`. */ static void share_uris_action (GSimpleAction *action, diff --git a/src/plugins/share/valent-share-text-dialog.c b/src/plugins/share/valent-share-text-dialog.c index 86da04a416..0bce70423f 100644 --- a/src/plugins/share/valent-share-text-dialog.c +++ b/src/plugins/share/valent-share-text-dialog.c @@ -227,7 +227,7 @@ valent_share_text_dialog_init (ValentShareTextDialog *self) /** * valent_share_text_dialog_get_text: - * @dialog: a #ValentShareTextDialog + * @dialog: a `ValentShareTextDialog` * * Get the text content shared by the remote [class@Valent.Device]. * @@ -243,7 +243,7 @@ valent_share_text_dialog_get_text (ValentShareTextDialog *dialog) /** * valent_share_text_dialog_set_text: - * @self: a #ValentShareTextDialog + * @self: a `ValentShareTextDialog` * @text: (nullable): text content * * Set the text content shared by the remote [class@Valent.Device]. diff --git a/src/plugins/share/valent-share-upload.c b/src/plugins/share/valent-share-upload.c index bafcaa1a8f..1e01e9c7b6 100644 --- a/src/plugins/share/valent-share-upload.c +++ b/src/plugins/share/valent-share-upload.c @@ -16,8 +16,8 @@ * * A class for multi-file uploads. * - * #ValentShareUpload is a class that supports multi-file uploads for - * #ValentSharePlugin. + * `ValentShareUpload` is a class that supports multi-file uploads for + * `ValentSharePlugin`. */ struct _ValentShareUpload @@ -302,11 +302,11 @@ valent_share_upload_init (ValentShareUpload *self) /** * valent_share_upload_new: - * @device: a #ValentDevice + * @device: a `ValentDevice` * - * Create a new #ValentShareUpload. + * Create a new `ValentShareUpload`. * - * Returns: (transfer full): a new #ValentShareUpload + * Returns: (transfer full): a new `ValentShareUpload` */ ValentTransfer * valent_share_upload_new (ValentDevice *device) @@ -425,8 +425,8 @@ valent_share_upload_add_files_task (GTask *task, /** * valent_share_upload_add_file: - * @group: a #ValentShareUpload - * @file: a #GFile + * @group: a `ValentShareUpload` + * @file: a `GFile` * * Add @file to the transfer operation. */ @@ -457,8 +457,8 @@ valent_share_upload_add_file (ValentShareUpload *upload, /** * valent_share_upload_add_files: - * @group: a #ValentShareUpload - * @files: a #GListModel + * @group: a `ValentShareUpload` + * @files: a `GListModel` * * Add @files to the transfer operation. * diff --git a/src/plugins/sms/valent-contact-row.c b/src/plugins/sms/valent-contact-row.c index a5a695f0b5..bdf012f617 100644 --- a/src/plugins/sms/valent-contact-row.c +++ b/src/plugins/sms/valent-contact-row.c @@ -120,7 +120,7 @@ valent_contact_row_class_init (ValentContactRowClass *klass) /** * ValentContactRow:contact * - * The #EContact for this row. + * The `EContact` for this row. */ properties [PROP_CONTACT] = g_param_spec_object ("contact", NULL, NULL, @@ -149,7 +149,7 @@ valent_contact_row_class_init (ValentContactRowClass *klass) * ValentContactRow:contact-name * * The contact name displayed in the row, by default the full name of - * #ValentContactRow:contact. + * `ValentContactRow`:contact. */ properties [PROP_CONTACT_NAME] = g_param_spec_string ("contact-name", NULL, NULL, @@ -218,15 +218,15 @@ valent_contact_row_init (ValentContactRow *self) /** * valent_contact_row_header_func: - * @row: a #GtkListBoxRow - * @before: (nullable): a #GtkListBoxRow + * @row: a `GtkListBoxRow` + * @before: (nullable): a `GtkListBoxRow` * @user_data: (closure): user supplied data * - * A #GtkListBoxHeaderFunc for #ValentContactRow widgets that takes care of + * A `GtkListBoxHeaderFunc` for `ValentContactRow` widgets that takes care of * hiding or showing the avatar and name depending on whether the row is * grouped with other rows for the same contact. * - * For example, if @before is not a #ValentContactRow or for a different #EContact + * For example, if @before is not a `ValentContactRow` or for a different `EContact` * the avatar and name will be shown, otherwise it's considered a secondary row. */ void @@ -280,10 +280,10 @@ valent_contact_row_header_func (GtkListBoxRow *row, /** * valent_list_add_contact: - * @list: a #GtkListBox - * @contact: an #EContact + * @list: a `GtkListBox` + * @contact: an `EContact` * - * A convenience for adding a #ValentContactRow to @list for each @contact + * A convenience for adding a `ValentContactRow` to @list for each @contact * number. */ void @@ -334,11 +334,11 @@ valent_list_add_contact (GtkListBox *list, /** * valent_contact_row_new: - * @contact: an #EContact + * @contact: an `EContact` * - * Create a new #ValentContactRow for @contact. + * Create a new `ValentContactRow` for @contact. * - * Returns: (transfer full): a new #ValentContactRow + * Returns: (transfer full): a new `ValentContactRow` */ GtkWidget * valent_contact_row_new (EContact *contact) @@ -350,7 +350,7 @@ valent_contact_row_new (EContact *contact) /** * valent_contact_row_set_compact: - * @row: a #ValentContactRow + * @row: a `ValentContactRow` * @compact: %TRUE or %FALSE * * Set whether @row should display the name and avatar (%FALSE) or not (%TRUE). @@ -378,11 +378,11 @@ valent_contact_row_set_compact (ValentContactRow *row, /** * valent_contact_row_get_contact: - * @row: a #ValentContactRow + * @row: a `ValentContactRow` * - * Get the #EContact for @row. + * Get the `EContact` for @row. * - * Returns: (transfer none): a #EContact + * Returns: (transfer none): a `EContact` */ EContact * valent_contact_row_get_contact (ValentContactRow *row) @@ -394,10 +394,10 @@ valent_contact_row_get_contact (ValentContactRow *row) /** * valent_contact_row_set_contact: - * @row: a #ValentContactRow - * @contact: a #ValentContact + * @row: a `ValentContactRow` + * @contact: a `ValentContact` * - * Set the #ValentContact for @row. + * Set the `ValentContact` for @row. */ void valent_contact_row_set_contact (ValentContactRow *row, @@ -424,7 +424,7 @@ valent_contact_row_set_contact (ValentContactRow *row, /** * valent_contact_row_get_contact_address: - * @row: a #ValentContactRow + * @row: a `ValentContactRow` * * Get the contact address displayed in @row. * @@ -440,7 +440,7 @@ valent_contact_row_get_contact_address (ValentContactRow *row) /** * valent_contact_row_set_contact_address: - * @row: a #ValentContactRow + * @row: a `ValentContactRow` * @address: a phone number or other address * * Set the contact address displayed in @row. @@ -457,7 +457,7 @@ valent_contact_row_set_contact_address (ValentContactRow *row, /** * valent_contact_row_get_contact_name: - * @row: a #ValentContactRow + * @row: a `ValentContactRow` * * Get the contact name displayed in @row. * @@ -473,7 +473,7 @@ valent_contact_row_get_contact_name (ValentContactRow *row) /** * valent_contact_row_set_contact_name: - * @row: a #ValentContactRow + * @row: a `ValentContactRow` * @name: a contact name * * Set the contact name displayed in @row. diff --git a/src/plugins/sms/valent-date-label.c b/src/plugins/sms/valent-date-label.c index 48577f9160..6ae547fecd 100644 --- a/src/plugins/sms/valent-date-label.c +++ b/src/plugins/sms/valent-date-label.c @@ -298,9 +298,9 @@ valent_date_label_init (ValentDateLabel *self) * valent_date_label_new: * @date: a UNIX epoch timestamp * - * Create a new #ValentDateLabel for @timestamp. + * Create a new `ValentDateLabel` for @timestamp. * - * Returns: (transfer full): a #GtkWidget + * Returns: (transfer full): a `GtkWidget` */ GtkWidget * valent_date_label_new (int64_t date) @@ -312,7 +312,7 @@ valent_date_label_new (int64_t date) /** * valent_date_label_get_date: - * @label: a #ValentDateLabel + * @label: a `ValentDateLabel` * * Get the UNIX epoch timestamp (ms) for @label. * @@ -328,7 +328,7 @@ valent_date_label_get_date (ValentDateLabel *label) /** * valent_date_label_set_date: - * @label: a #ValentDateLabel + * @label: a `ValentDateLabel` * @date: a UNIX epoch timestamp * * Set the timestamp for @label to @date. @@ -349,7 +349,7 @@ valent_date_label_set_date (ValentDateLabel *label, /** * valent_date_label_get_mode: - * @label: a #ValentDateLabel + * @label: a `ValentDateLabel` * * Get the display mode @label. * @@ -365,7 +365,7 @@ valent_date_label_get_mode (ValentDateLabel *label) /** * valent_date_label_set_mode: - * @label: a #ValentDateLabel + * @label: a `ValentDateLabel` * @mode: a mode * * Set the mode of @label to @mode. Currently the options are `0` and `1`. @@ -386,7 +386,7 @@ valent_date_label_set_mode (ValentDateLabel *label, /** * valent_date_label_update: - * @label: a #ValentDateLabel + * @label: a `ValentDateLabel` * * Update the displayed text of @label. */ diff --git a/src/plugins/sms/valent-message-row.c b/src/plugins/sms/valent-message-row.c index 07f6541a92..4c45e774d7 100644 --- a/src/plugins/sms/valent-message-row.c +++ b/src/plugins/sms/valent-message-row.c @@ -120,7 +120,7 @@ valent_message_row_class_init (ValentMessageRowClass *klass) /** * ValentMessageRow:contact * - * The #EContact that sent this message. + * The `EContact` that sent this message. */ properties [PROP_CONTACT] = g_param_spec_object ("contact", NULL, NULL, @@ -213,12 +213,12 @@ valent_message_row_init (ValentMessageRow *self) /** * valent_message_row_new: - * @message: (nullable): a #ValentMessage - * @contact: (nullable): a #EContact + * @message: (nullable): a `ValentMessage` + * @contact: (nullable): a `EContact` * * Create a new message row for @contact and @message. * - * Returns: a #ValentMessageRow + * Returns: a `ValentMessageRow` */ GtkWidget * valent_message_row_new (ValentMessage *message, @@ -232,11 +232,11 @@ valent_message_row_new (ValentMessage *message, /** * valent_message_row_get_contact: - * @row: a #ValentMessageRow + * @row: a `ValentMessageRow` * * Get the contact. * - * Returns: (transfer none) (nullable): a #ValentContact + * Returns: (transfer none) (nullable): a `ValentContact` */ EContact * valent_message_row_get_contact (ValentMessageRow *row) @@ -248,8 +248,8 @@ valent_message_row_get_contact (ValentMessageRow *row) /** * valent_message_row_set_contact: - * @row: a #ValentMessageRow - * @contact: a #ValentContact + * @row: a `ValentMessageRow` + * @contact: a `ValentContact` * * Set or update the contact. */ @@ -272,7 +272,7 @@ valent_message_row_set_contact (ValentMessageRow *row, /** * valent_message_row_get_thread_id: - * @row: a #ValentMessageRow + * @row: a `ValentMessageRow` * * Get the thread_id of the message. * @@ -291,11 +291,11 @@ valent_message_row_get_thread_id (ValentMessageRow *row) /** * valent_message_row_get_message: - * @row: a #ValentMessageRow + * @row: a `ValentMessageRow` * * Get the message. * - * Returns: (transfer none): a #ValentMessage + * Returns: (transfer none): a `ValentMessage` */ ValentMessage * valent_message_row_get_message (ValentMessageRow *row) @@ -307,8 +307,8 @@ valent_message_row_get_message (ValentMessageRow *row) /** * valent_message_row_set_message: - * @row: a #ValentMessageRow - * @message: a #ValentMessage + * @row: a `ValentMessageRow` + * @message: a `ValentMessage` * * Set or update the message. */ @@ -343,10 +343,10 @@ valent_message_row_set_message (ValentMessageRow *row, /** * valent_message_row_update: - * @row: a #ValentMessageRow + * @row: a `ValentMessageRow` * - * Update the conversation row with data from #ValentMessageRow:contact - * and #ValentMessageRow:message properties. + * Update the conversation row with data from `ValentMessageRow`:contact + * and `ValentMessageRow`:message properties. */ void valent_message_row_update (ValentMessageRow *row) diff --git a/src/plugins/sms/valent-message-thread.c b/src/plugins/sms/valent-message-thread.c index e87e386312..bb1219e2a1 100644 --- a/src/plugins/sms/valent-message-thread.c +++ b/src/plugins/sms/valent-message-thread.c @@ -345,7 +345,7 @@ valent_message_thread_class_init (ValentMessageThreadClass *klass) /** * ValentMessageThread:message-store: * - * The #ValentSmsStore providing #ValentMessage objects for the thread. + * The `ValentSmsStore` providing `ValentMessage` objects for the thread. */ properties [PROP_STORE] = g_param_spec_object ("store", NULL, NULL, @@ -370,9 +370,9 @@ valent_message_thread_init (ValentMessageThread *self) * @store: a @ValentSmsStore * @id: a thread ID * - * Create a new #ValentMessageThread. + * Create a new `ValentMessageThread`. * - * Returns: (transfer full): a #GListModel + * Returns: (transfer full): a `GListModel` */ GListModel * valent_message_thread_new (ValentSmsStore *store, @@ -389,7 +389,7 @@ valent_message_thread_new (ValentSmsStore *store, /** * valent_message_thread_get_id: - * @thread: a #ValentMessageThread + * @thread: a `ValentMessageThread` * * Get the thread ID for @thread. * @@ -405,7 +405,7 @@ valent_message_thread_get_id (ValentMessageThread *thread) /** * valent_message_thread_set_id: - * @thread: a #ValentMessageThread + * @thread: a `ValentMessageThread` * @id: a thread ID * * Set the thread ID for @thread to @id. @@ -433,11 +433,11 @@ valent_message_thread_set_id (ValentMessageThread *thread, /** * valent_message_thread_get_db: - * @thread: a #ValentMessageThread + * @thread: a `ValentMessageThread` * * Get the thread ID for @thread. * - * Returns: a #ValentSmsStore + * Returns: a `ValentSmsStore` */ ValentSmsStore * valent_message_thread_get_store (ValentMessageThread *thread) diff --git a/src/plugins/sms/valent-message.c b/src/plugins/sms/valent-message.c index 88046df270..bf612c7b10 100644 --- a/src/plugins/sms/valent-message.c +++ b/src/plugins/sms/valent-message.c @@ -164,7 +164,7 @@ valent_message_class_init (ValentMessageClass *klass) /** * ValentMessage:box: * - * The #ValentMessageBox of the message. + * The `ValentMessageBox` of the message. */ properties [PROP_BOX] = g_param_spec_uint ("box", NULL, NULL, @@ -280,11 +280,11 @@ valent_message_init (ValentMessage *message) /** * valent_message_get_box: - * @message: a #ValentMessage + * @message: a `ValentMessage` * - * Get the #ValentMessageBox of @message. + * Get the `ValentMessageBox` of @message. * - * Returns: a #ValentMessageBox + * Returns: a `ValentMessageBox` */ ValentMessageBox valent_message_get_box (ValentMessage *message) @@ -296,7 +296,7 @@ valent_message_get_box (ValentMessage *message) /** * valent_message_get_date: - * @message: a #ValentMessage + * @message: a `ValentMessage` * * Get the timestamp for @message. * @@ -312,7 +312,7 @@ valent_message_get_date (ValentMessage *message) /** * valent_message_get_id: - * @message: a #ValentMessage + * @message: a `ValentMessage` * * Get the unique ID for @message. * @@ -328,9 +328,9 @@ valent_message_get_id (ValentMessage *message) /** * valent_message_get_metadata: - * @message: a #ValentMessage + * @message: a `ValentMessage` * - * Get the #GVariant dictionary of metadata. + * Get the `GVariant` dictionary of metadata. * * Returns: (transfer none) (nullable): the metadata */ @@ -344,7 +344,7 @@ valent_message_get_metadata (ValentMessage *message) /** * valent_message_get_read: - * @message: a #ValentMessage + * @message: a `ValentMessage` * * Get the read status of @message. * @@ -360,7 +360,7 @@ valent_message_get_read (ValentMessage *message) /** * valent_message_set_read: - * @message: a #ValentMessage + * @message: a `ValentMessage` * @read: whether the message is read * * Set the read status of @message to @read. @@ -380,7 +380,7 @@ valent_message_set_read (ValentMessage *message, /** * valent_message_get_sender: - * @message: a #ValentMessage + * @message: a `ValentMessage` * * Get the sender of @message. * @@ -396,7 +396,7 @@ valent_message_get_sender (ValentMessage *message) /** * valent_message_get_text: - * @message: a #ValentMessage + * @message: a `ValentMessage` * * Get the text content of @message. * @@ -412,7 +412,7 @@ valent_message_get_text (ValentMessage *message) /** * valent_message_get_thread_id: - * @message: a #ValentMessage + * @message: a `ValentMessage` * * Get the thread ID @message belongs to. * @@ -428,10 +428,10 @@ valent_message_get_thread_id (ValentMessage *message) /** * valent_message_update: - * @message: a #ValentMessage - * @update: (transfer full): a #ValentMessage + * @message: a `ValentMessage` + * @update: (transfer full): a `ValentMessage` * - * Update @message with data from @update. The #ValentMessage:id property + * Update @message with data from @update. The `ValentMessage`:id property * must match on both objects. * * This function consumes @update and all its memory, so it should not be used diff --git a/src/plugins/sms/valent-sms-conversation-row.c b/src/plugins/sms/valent-sms-conversation-row.c index 2f6eb92e2d..cf9f10e7bc 100644 --- a/src/plugins/sms/valent-sms-conversation-row.c +++ b/src/plugins/sms/valent-sms-conversation-row.c @@ -150,7 +150,7 @@ valent_sms_conversation_row_class_init (ValentSmsConversationRowClass *klass) /** * ValentSmsConversationRow:contact * - * The #EContact that sent this message. + * The `EContact` that sent this message. */ properties [PROP_CONTACT] = g_param_spec_object ("contact", NULL, NULL, @@ -240,12 +240,12 @@ valent_sms_conversation_row_init (ValentSmsConversationRow *self) /** * valent_sms_conversation_row_new: - * @message: a #ValentMessage - * @contact: a #EContact + * @message: a `ValentMessage` + * @contact: a `EContact` * * Create a new conversation message for @contact and @message. * - * Returns: (transfer full): a #ValentSmsConversationRow + * Returns: (transfer full): a `ValentSmsConversationRow` */ GtkWidget * valent_sms_conversation_row_new (ValentMessage *message, @@ -259,11 +259,11 @@ valent_sms_conversation_row_new (ValentMessage *message, /** * valent_sms_conversation_row_get_contact: - * @row: a #ValentSmsConversationRow + * @row: a `ValentSmsConversationRow` * * Get the contact. * - * Returns: (transfer none) (nullable): a #ValentContact + * Returns: (transfer none) (nullable): a `ValentContact` */ EContact * valent_sms_conversation_row_get_contact (ValentSmsConversationRow *row) @@ -275,8 +275,8 @@ valent_sms_conversation_row_get_contact (ValentSmsConversationRow *row) /** * valent_sms_conversation_row_set_contact: - * @row: a #ValentSmsConversationRow - * @contact: a #ValentContact + * @row: a `ValentSmsConversationRow` + * @contact: a `ValentContact` * * Set or update the contact. */ @@ -299,7 +299,7 @@ valent_sms_conversation_row_set_contact (ValentSmsConversationRow *row, /** * valent_sms_conversation_row_get_date: - * @row: a #ValentSmsConversationRow + * @row: a `ValentSmsConversationRow` * * Get the timestamp of the message. * @@ -318,7 +318,7 @@ valent_sms_conversation_row_get_date (ValentSmsConversationRow *row) /** * valent_sms_conversation_row_get_id: - * @row: a #ValentSmsConversationRow + * @row: a `ValentSmsConversationRow` * * Get the ID of the message. * @@ -337,11 +337,11 @@ valent_sms_conversation_row_get_id (ValentSmsConversationRow *row) /** * valent_sms_conversation_row_get_message: - * @row: a #ValentSmsConversationRow + * @row: a `ValentSmsConversationRow` * * Get the message. * - * Returns: (transfer none): a #ValentMessage + * Returns: (transfer none): a `ValentMessage` */ ValentMessage * valent_sms_conversation_row_get_message (ValentSmsConversationRow *row) @@ -353,8 +353,8 @@ valent_sms_conversation_row_get_message (ValentSmsConversationRow *row) /** * valent_sms_conversation_row_set_message: - * @row: a #ValentSmsConversationRow - * @message: a #ValentMessage + * @row: a `ValentSmsConversationRow` + * @message: a `ValentMessage` * * Set or update the message. */ @@ -389,9 +389,9 @@ valent_sms_conversation_row_set_message (ValentSmsConversationRow *row, /** * valent_sms_conversation_row_is_incoming: - * @row: a #ValentSmsConversationRow + * @row: a `ValentSmsConversationRow` * - * Update @row based on the current values of #ValentSmsConversation:message. + * Update @row based on the current values of `ValentSmsConversation`:message. */ gboolean valent_sms_conversation_row_is_incoming (ValentSmsConversationRow *row) @@ -406,7 +406,7 @@ valent_sms_conversation_row_is_incoming (ValentSmsConversationRow *row) /** * valent_sms_conversation_row_show_avatar: - * @row: a #ValentSmsConversationRow + * @row: a `ValentSmsConversationRow` * @visible: Whether to show the avatar * * Show or hide the contact avatar for @row, updating the margins accordingly. @@ -436,9 +436,9 @@ valent_sms_conversation_row_show_avatar (ValentSmsConversationRow *row, /** * valent_sms_conversation_row_update: - * @row: a #ValentSmsConversationRow + * @row: a `ValentSmsConversationRow` * - * Update @row based on the current values of #ValentSmsConversation:message. + * Update @row based on the current values of `ValentSmsConversation`:message. */ void valent_sms_conversation_row_update (ValentSmsConversationRow *row) diff --git a/src/plugins/sms/valent-sms-conversation.c b/src/plugins/sms/valent-sms-conversation.c index 35547bc077..985cd3f7cb 100644 --- a/src/plugins/sms/valent-sms-conversation.c +++ b/src/plugins/sms/valent-sms-conversation.c @@ -191,14 +191,14 @@ message_list_header_func (GtkListBoxRow *row, /** * valent_sms_conversation_insert_message: - * @conversation: a #ValentSmsConversation - * @message: a #ValentMessage + * @conversation: a `ValentSmsConversation` + * @message: a `ValentMessage` * @position: position to insert the widget * * Create a new message row for @message and insert it into the message list at * @position. * - * Returns: (transfer none): a #GtkWidget + * Returns: (transfer none): a `GtkWidget` */ static GtkWidget * valent_sms_conversation_insert_message (ValentSmsConversation *self, @@ -257,8 +257,8 @@ valent_sms_conversation_insert_message (ValentSmsConversation *self, #if 0 /** * valent_conversation_remove_message: - * @conversation: a #ValentSmsConversation - * @message: a #ValentMessage + * @conversation: a `ValentSmsConversation` + * @message: a `ValentMessage` * * Remove a message from the conversation. */ @@ -727,7 +727,7 @@ valent_sms_conversation_class_init (ValentSmsConversationClass *klass) /** * ValentSmsConversation:contact-store: * - * The #ValentContactStore providing #EContact objects for the conversation. + * The `ValentContactStore` providing `EContact` objects for the conversation. */ properties [PROP_CONTACT_STORE] = g_param_spec_object ("contact-store", NULL, NULL, @@ -740,7 +740,7 @@ valent_sms_conversation_class_init (ValentSmsConversationClass *klass) /** * ValentSmsConversation:message-store: * - * The #ValentSmsStore providing #ValentMessage objects for the + * The `ValentSmsStore` providing `ValentMessage` objects for the * conversation. */ properties [PROP_MESSAGE_STORE] = @@ -769,10 +769,10 @@ valent_sms_conversation_class_init (ValentSmsConversationClass *klass) /** * ValentSmsConversation::send-message: - * @conversation: a #ValentSmsConversation + * @conversation: a `ValentSmsConversation` * @message: a message * - * The #ValentSmsConversation::send-message signal is emitted when a user is + * The `ValentSmsConversation`::send-message signal is emitted when a user is * sending an outgoing message. * * The signal handler should return a boolean indicating success, although @@ -822,7 +822,7 @@ valent_sms_conversation_new (ValentContactStore *contacts, /** * valent_sms_conversation_get_thread_id: - * @conversation: a #ValentSmsConversation + * @conversation: a `ValentSmsConversation` * * Get the thread ID for @conversation. * @@ -838,7 +838,7 @@ valent_sms_conversation_get_thread_id (ValentSmsConversation *conversation) /** * valent_sms_conversation_set_thread_id: - * @conversation: a #ValentSmsConversation + * @conversation: a `ValentSmsConversation` * @thread_id: a thread ID * * Set the thread ID for @conversation. @@ -876,7 +876,7 @@ valent_sms_conversation_set_thread_id (ValentSmsConversation *conversation, /** * valent_sms_conversation_get_title: - * @conversation: a #ValentSmsConversation + * @conversation: a `ValentSmsConversation` * * Get the title of the conversation, usually the contact name. * @@ -931,7 +931,7 @@ valent_sms_conversation_get_title (ValentSmsConversation *conversation) /** * valent_sms_conversation_get_subtitle: - * @conversation: a #ValentSmsConversation + * @conversation: a `ValentSmsConversation` * * Get the subtitle of the conversation. If the conversation has one recipient * this will be its address (eg. phone number), otherwise it will be a string @@ -952,7 +952,7 @@ valent_sms_conversation_get_subtitle (ValentSmsConversation *conversation) /** * valent_sms_conversation_scroll_to_date: - * @conversation: a #ValentSmsConversation + * @conversation: a `ValentSmsConversation` * @date: a UNIX epoch timestamp * * Scroll to the message closest to @date. @@ -1004,8 +1004,8 @@ valent_sms_conversation_scroll_to_date (ValentSmsConversation *conversation, /** * valent_sms_conversation_scroll_to_message: - * @conversation: a #ValentSmsConversation - * @message: a #ValentMessage + * @conversation: a `ValentSmsConversation` + * @message: a `ValentMessage` * * A convenience for calling valent_message_get_date() and then * valent_sms_conversation_scroll_to_date(). diff --git a/src/plugins/sms/valent-sms-plugin.c b/src/plugins/sms/valent-sms-plugin.c index 98ff4b3480..1bef6f7270 100644 --- a/src/plugins/sms/valent-sms-plugin.c +++ b/src/plugins/sms/valent-sms-plugin.c @@ -167,7 +167,7 @@ valent_sms_plugin_deserialize_message (ValentSmsPlugin *self, /** * messages_is_thread: - * @messages: a #JsonArray + * @messages: a `JsonArray` * * Check if @messages is a thread of messages, or a summary of threads. * diff --git a/src/plugins/sms/valent-sms-store-private.h b/src/plugins/sms/valent-sms-store-private.h index e9352ccec8..47b43e181a 100644 --- a/src/plugins/sms/valent-sms-store-private.h +++ b/src/plugins/sms/valent-sms-store-private.h @@ -22,7 +22,7 @@ void valent_sms_store_get_thread_items (ValentSmsStore *store, * @box: (type Valent.MessageBox): * @date: (type int64_t): a UNIX epoch timestamp (ms) * @id: (type int64_t): a message ID, unique to at least @thread_id - * @metadata: (type GLib.Variant): additional serialized #GVariant data + * @metadata: (type GLib.Variant): additional serialized `GVariant` data * @read: (type gboolean): the viewed status * @sender: (type utf8): the sender address * @text: (type utf8): the message content @@ -30,14 +30,14 @@ void valent_sms_store_get_thread_items (ValentSmsStore *store, * * The SQL query used to create the `message` table, which holds records of * abstract messages. The most commonly searched properties are fields, while - * additional data is stored as serialized #GVariant data in metadata. + * additional data is stored as serialized `GVariant` data in metadata. * * In general, messages are organized in groups by @thread_id and sorted by * @date in ascending order. Each database entry is meant to map perfectly to - * #ValentMessage, such that the column IDs match the property IDs and the + * `ValentMessage`, such that the column IDs match the property IDs and the * column values are equivalent or safe to cast. * - * Additional data is found in the @metadata #GVariant dictionary. + * Additional data is found in the @metadata `GVariant` dictionary. */ #define MESSAGE_TABLE_SQL \ "CREATE TABLE IF NOT EXISTS message (" \ diff --git a/src/plugins/sms/valent-sms-store.c b/src/plugins/sms/valent-sms-store.c index 453b9129a7..11838e215f 100644 --- a/src/plugins/sms/valent-sms-store.c +++ b/src/plugins/sms/valent-sms-store.c @@ -921,8 +921,8 @@ valent_sms_store_class_init (ValentSmsStoreClass *klass) /** * ValentSmsStore::message-added: - * @store: a #ValentSmsStore - * @message: a #ValentMessage + * @store: a `ValentSmsStore` + * @message: a `ValentMessage` * * ValentSmsStore::message-added is emitted when a new message is added to * @store. @@ -941,8 +941,8 @@ valent_sms_store_class_init (ValentSmsStoreClass *klass) /** * ValentSmsStore::message-changed: - * @store: a #ValentSmsStore - * @message: a #ValentMessage + * @store: a `ValentSmsStore` + * @message: a `ValentMessage` * * ValentSmsStore::message-changed is emitted when a message is updated in * @store. @@ -961,8 +961,8 @@ valent_sms_store_class_init (ValentSmsStoreClass *klass) /** * ValentSmsStore::message-removed: - * @store: a #ValentSmsStore - * @message: a #ValentMessage + * @store: a `ValentSmsStore` + * @message: a `ValentMessage` * * ValentSmsStore::message-removed is emitted when a message is removed from * @store. @@ -999,9 +999,9 @@ valent_sms_store_init (ValentSmsStore *self) /** * valent_sms_store_new: - * @parent: a #ValentContext + * @parent: a `ValentContext` * - * Create a new #ValentSmsStore. + * Create a new `ValentSmsStore`. * * Returns: (transfer full): a new sms store */ @@ -1017,10 +1017,10 @@ valent_sms_store_new (ValentContext *parent) /** * valent_sms_store_add_message: - * @store: a #ValentSmsStore - * @message: a #ValentMessage - * @cancellable: (nullable): a #GCancellable - * @callback: (scope async): a #GAsyncReadyCallback + * @store: a `ValentSmsStore` + * @message: a `ValentMessage` + * @cancellable: (nullable): a `GCancellable` + * @callback: (scope async): a `GAsyncReadyCallback` * @user_data: (closure): user supplied data * * Add @message to @store. @@ -1051,10 +1051,10 @@ valent_sms_store_add_message (ValentSmsStore *store, /** * valent_sms_store_add_messages: - * @store: a #ValentSmsStore - * @messages: (element-type Valent.Message): a #ValentMessage - * @cancellable: (nullable): a #GCancellable - * @callback: (scope async): a #GAsyncReadyCallback + * @store: a `ValentSmsStore` + * @messages: (element-type Valent.Message): a `ValentMessage` + * @cancellable: (nullable): a `GCancellable` + * @callback: (scope async): a `GAsyncReadyCallback` * @user_data: (closure): user supplied data * * Add @messages to @store. @@ -1081,9 +1081,9 @@ valent_sms_store_add_messages (ValentSmsStore *store, /** * valent_sms_store_add_messages_finish: - * @store: a #ValentSmsStore - * @result: a #GAsyncResult - * @error: (nullable): a #GError + * @store: a `ValentSmsStore` + * @result: a `GAsyncResult` + * @error: (nullable): a `GError` * * Finish an operation started by valent_sms_store_add_messages(). * @@ -1103,10 +1103,10 @@ valent_sms_store_add_messages_finish (ValentSmsStore *store, /** * valent_sms_store_remove_message: - * @store: a #ValentSmsStore + * @store: a `ValentSmsStore` * @message_id: a message ID - * @cancellable: (nullable): a #GCancellable - * @callback: (scope async): a #GAsyncReadyCallback + * @cancellable: (nullable): a `GCancellable` + * @callback: (scope async): a `GAsyncReadyCallback` * @user_data: (closure): user supplied data * * Remove the message with @message_id from @thread_id. @@ -1134,9 +1134,9 @@ valent_sms_store_remove_message (ValentSmsStore *store, /** * valent_sms_store_remove_message_finish: - * @store: a #ValentSmsStore - * @result: a #GAsyncResult - * @error: (nullable): a #GError + * @store: a `ValentSmsStore` + * @result: a `GAsyncResult` + * @error: (nullable): a `GError` * * Finish an operation started by valent_sms_store_remove_message(). * @@ -1156,10 +1156,10 @@ valent_sms_store_remove_message_finish (ValentSmsStore *store, /** * valent_sms_store_remove_thread: - * @store: a #ValentSmsStore + * @store: a `ValentSmsStore` * @thread_id: a thread ID - * @cancellable: (nullable): a #GCancellable - * @callback: (scope async): a #GAsyncReadyCallback + * @cancellable: (nullable): a `GCancellable` + * @callback: (scope async): a `GAsyncReadyCallback` * @user_data: (closure): user supplied data * * Remove @thread_id and all it's messages from @store. @@ -1188,9 +1188,9 @@ valent_sms_store_remove_thread (ValentSmsStore *store, /** * valent_sms_store_remove_thread_finish: - * @store: a #ValentSmsStore - * @result: a #GAsyncResult - * @error: (nullable): a #GError + * @store: a `ValentSmsStore` + * @result: a `GAsyncResult` + * @error: (nullable): a `GError` * * Finish an operation started by valent_sms_store_remove_thread(). * @@ -1210,10 +1210,10 @@ valent_sms_store_remove_thread_finish (ValentSmsStore *store, /** * valent_sms_store_find_messages: - * @store: a #ValentSmsStore + * @store: a `ValentSmsStore` * @query: a string to search for - * @cancellable: (nullable): a #GCancellable - * @callback: (scope async): a #GAsyncReadyCallback + * @cancellable: (nullable): a `GCancellable` + * @callback: (scope async): a `GAsyncReadyCallback` * @user_data: (closure): user supplied data * * Search through all the messages in @store and return the most recent message @@ -1242,13 +1242,13 @@ valent_sms_store_find_messages (ValentSmsStore *store, /** * valent_sms_store_find_messages_finish: - * @store: a #ValentSmsStore - * @result: a #GAsyncResult - * @error: (nullable): a #GError + * @store: a `ValentSmsStore` + * @result: a `GAsyncResult` + * @error: (nullable): a `GError` * * Finish an operation started by valent_sms_store_find_messages(). * - * Returns: (transfer container) (element-type Valent.Message): an #GPtrArray + * Returns: (transfer container) (element-type Valent.Message): an `GPtrArray` */ GPtrArray * valent_sms_store_find_messages_finish (ValentSmsStore *store, @@ -1264,15 +1264,15 @@ valent_sms_store_find_messages_finish (ValentSmsStore *store, /** * valent_sms_store_get_message: - * @store: a #ValentSmsStore + * @store: a `ValentSmsStore` * @message_id: a message ID - * @cancellable: (nullable): a #GCancellable - * @callback: (scope async): a #GAsyncReadyCallback + * @cancellable: (nullable): a `GCancellable` + * @callback: (scope async): a `GAsyncReadyCallback` * @user_data: (closure): user supplied data * - * Get the #ValentMessage with @message_id or %NULL if not found. + * Get the `ValentMessage` with @message_id or %NULL if not found. * - * Returns: (transfer none) (nullable): a #ValentMessage + * Returns: (transfer none) (nullable): a `ValentMessage` */ void valent_sms_store_get_message (ValentSmsStore *store, @@ -1298,13 +1298,13 @@ valent_sms_store_get_message (ValentSmsStore *store, /** * valent_sms_store_get_message_finish: - * @store: a #ValentSmsStore - * @result: a #GAsyncResult - * @error: (nullable): a #GError + * @store: a `ValentSmsStore` + * @result: a `GAsyncResult` + * @error: (nullable): a `GError` * * Finish an operation started by valent_sms_store_get_message(). * - * Returns: (transfer full) (nullable): a #ValentMessage + * Returns: (transfer full) (nullable): a `ValentMessage` */ ValentMessage * valent_sms_store_get_message_finish (ValentSmsStore *store, @@ -1320,11 +1320,11 @@ valent_sms_store_get_message_finish (ValentSmsStore *store, /** * valent_sms_store_get_summary: - * @store: a #ValentSmsStore + * @store: a `ValentSmsStore` * - * Get the latest message of each thread as a #GListModel. + * Get the latest message of each thread as a `GListModel`. * - * Returns: (transfer full) (nullable): a #GListModel + * Returns: (transfer full) (nullable): a `GListModel` */ GListModel * valent_sms_store_get_summary (ValentSmsStore *store) @@ -1349,12 +1349,12 @@ valent_sms_store_get_summary (ValentSmsStore *store) /** * valent_sms_store_get_thread: - * @store: a #ValentSmsStore + * @store: a `ValentSmsStore` * @thread_id: a message id * - * Get the thread with @thread_id as a #GListModel. + * Get the thread with @thread_id as a `GListModel`. * - * Returns: (transfer full): a #GListModel + * Returns: (transfer full): a `GListModel` */ GListModel * valent_sms_store_get_thread (ValentSmsStore *store, @@ -1368,7 +1368,7 @@ valent_sms_store_get_thread (ValentSmsStore *store, /** * valent_sms_store_get_thread_date: - * @store: a #ValentSmsStore + * @store: a `ValentSmsStore` * @thread_id: a thread ID * * Get the date of the last message in @thread_id. @@ -1404,10 +1404,10 @@ valent_sms_store_get_thread_date (ValentSmsStore *store, /** * valent_sms_store_get_thread_items: - * @store: a #ValentSmsStore + * @store: a `ValentSmsStore` * @thread_id: a thread ID * - * Get the #ValentMessage in @thread_id at @position, when sorted by date in + * Get the `ValentMessage` in @thread_id at @position, when sorted by date in * ascending order. */ void @@ -1434,13 +1434,13 @@ valent_sms_store_get_thread_items (ValentSmsStore *store, /** * valent_sms_store_message_added: - * @store: a #ValentSmsStore - * @message: a #ValentMessage + * @store: a `ValentSmsStore` + * @message: a `ValentMessage` * - * Emits the #ValentSmsStore::message-added signal on @store. + * Emits the `ValentSmsStore`::message-added signal on @store. * * This function should only be called by classes implementing - * #ValentSmsStore. It has to be called after the internal representation + * `ValentSmsStore`. It has to be called after the internal representation * of @store has been updated, because handlers connected to this signal * might query the new state of the provider. */ @@ -1475,13 +1475,13 @@ valent_sms_store_message_added (ValentSmsStore *store, /** * valent_sms_store_message_removed: - * @store: a #ValentSmsStore - * @message: a #ValentMessage + * @store: a `ValentSmsStore` + * @message: a `ValentMessage` * - * Emits the #ValentSmsStore::message-removed signal on @store. + * Emits the `ValentSmsStore`::message-removed signal on @store. * * This function should only be called by classes implementing - * #ValentSmsStore. It has to be called after the internal representation + * `ValentSmsStore`. It has to be called after the internal representation * of @store has been updated, because handlers connected to this signal * might query the new state of the provider. */ @@ -1516,13 +1516,13 @@ valent_sms_store_message_removed (ValentSmsStore *store, /** * valent_sms_store_message_changed: - * @store: a #ValentSmsStore - * @message: a #ValentMessage + * @store: a `ValentSmsStore` + * @message: a `ValentMessage` * - * Emits the #ValentSmsStore::message-changed signal on @store. + * Emits the `ValentSmsStore`::message-changed signal on @store. * * This function should only be called by classes implementing - * #ValentSmsStore. It has to be called after the internal representation + * `ValentSmsStore`. It has to be called after the internal representation * of @store has been updated, because handlers connected to this signal * might query the new state of the provider. */ diff --git a/src/plugins/sms/valent-sms-utils.c b/src/plugins/sms/valent-sms-utils.c index 84552bc055..c19a7e1e08 100644 --- a/src/plugins/sms/valent-sms-utils.c +++ b/src/plugins/sms/valent-sms-utils.c @@ -112,10 +112,10 @@ _e_contact_get_paintable (EContact *contact, /** * valent_sms_avatar_from_contact: - * @avatar: a #AdwAvatar - * @contact: a #EContact + * @avatar: a `AdwAvatar` + * @contact: a `EContact` * - * Set the #GdkPaintable for @avatar from @contact. + * Set the `GdkPaintable` for @avatar from @contact. */ void valent_sms_avatar_from_contact (AdwAvatar *avatar, @@ -189,10 +189,10 @@ valent_sms_contact_from_phone_cb (ValentContactStore *store, /** * valent_sms_contact_from_phone: - * @store: a #ValentContactStore + * @store: a `ValentContactStore` * @phone: a phone number - * @cancellable: (nullable): #GCancellable - * @callback: (scope async): a #GAsyncReadyCallback + * @cancellable: (nullable): `GCancellable` + * @callback: (scope async): a `GAsyncReadyCallback` * @user_data: (closure): user supplied data * * A convenience wrapper around [method@Valent.ContactStore.query] for finding a @@ -242,13 +242,13 @@ valent_sms_contact_from_phone (ValentContactStore *store, /** * valent_sms_contact_from_phone_finish: - * @store: a #ValentContactStore - * @result: a #GAsyncResult - * @error: (nullable): a #GError + * @store: a `ValentContactStore` + * @result: a `GAsyncResult` + * @error: (nullable): a `GError` * * Finish an operation started by valent_sms_contact_from_phone(). * - * Returns: (transfer full): an #EContact + * Returns: (transfer full): an `EContact` */ EContact * valent_sms_contact_from_phone_finish (ValentContactStore *store, @@ -362,7 +362,7 @@ valent_phone_number_equal (const char *number1, /** * valent_phone_number_of_contact: - * @contact: an #EContact + * @contact: an `EContact` * @number: a normalized phone number * * Check if @contact has @number as one of it's phone numbers. diff --git a/src/plugins/sms/valent-sms-window.c b/src/plugins/sms/valent-sms-window.c index 53c076e6b2..11c27f79f8 100644 --- a/src/plugins/sms/valent-sms-window.c +++ b/src/plugins/sms/valent-sms-window.c @@ -749,7 +749,7 @@ valent_sms_window_class_init (ValentSmsWindowClass *klass) /** * ValentSmsWindow:contact-store: * - * The #ValentContactStore providing contacts for the window. + * The `ValentContactStore` providing contacts for the window. */ properties [PROP_CONTACT_STORE] = g_param_spec_object ("contact-store", NULL, NULL, @@ -762,7 +762,7 @@ valent_sms_window_class_init (ValentSmsWindowClass *klass) /** * ValentSmsWindow:message-store: * - * The #ValentSmsStore providing messages for the window. + * The `ValentSmsStore` providing messages for the window. */ properties [PROP_MESSAGE_STORE] = g_param_spec_object ("message-store", NULL, NULL, @@ -776,11 +776,11 @@ valent_sms_window_class_init (ValentSmsWindowClass *klass) /** * ValentSmsWindow::send-message: - * @window: a #ValentSmsWindow - * @message: a #ValentMessage + * @window: a `ValentSmsWindow` + * @message: a `ValentMessage` * - * The #ValentSmsWindow::send-message signal is emitted when a child - * #ValentSmsConversation emits #ValentSmsConversation::send-message. + * The `ValentSmsWindow`::send-message signal is emitted when a child + * `ValentSmsConversation` emits `ValentSmsConversation`::send-message. * * The signal handler should return a boolean indicating success, although * this only indicates the request was sent to the device. @@ -829,11 +829,11 @@ valent_sms_window_init (ValentSmsWindow *self) /** * valent_sms_window_get_contact_store: - * @window: a #ValentSmsWindow + * @window: a `ValentSmsWindow` * - * Get the #ValentContactStore providing contacts for @window. + * Get the `ValentContactStore` providing contacts for @window. * - * Returns: (transfer none) (nullable): a #ValentContactStore + * Returns: (transfer none) (nullable): a `ValentContactStore` */ ValentContactStore * valent_sms_window_get_contact_store (ValentSmsWindow *window) @@ -845,10 +845,10 @@ valent_sms_window_get_contact_store (ValentSmsWindow *window) /** * valent_sms_window_set_contact_store: - * @window: a #ValentSmsWindow - * @store: a #ValentContactStore + * @window: a `ValentSmsWindow` + * @store: a `ValentContactStore` * - * Set the #ValentContactStore providing contacts for @window. + * Set the `ValentContactStore` providing contacts for @window. */ void valent_sms_window_set_contact_store (ValentSmsWindow *window, @@ -866,11 +866,11 @@ valent_sms_window_set_contact_store (ValentSmsWindow *window, /** * valent_sms_window_get_sms_store: - * @window: a #ValentSmsWindow + * @window: a `ValentSmsWindow` * - * Get the #ValentSmsStore providing messages for @window. + * Get the `ValentSmsStore` providing messages for @window. * - * Returns: (transfer none) (nullable): a #ValentSmsStore + * Returns: (transfer none) (nullable): a `ValentSmsStore` */ ValentSmsStore * valent_sms_window_get_message_store (ValentSmsWindow *window) @@ -882,7 +882,7 @@ valent_sms_window_get_message_store (ValentSmsWindow *window) /** * valent_sms_window_search_contacts: - * @window: a #ValentSmsWindow + * @window: a `ValentSmsWindow` * @query: query string * * Switch the contact view and search for @query. @@ -906,7 +906,7 @@ valent_sms_window_search_contacts (ValentSmsWindow *window, /** * valent_sms_window_search_messages: - * @window: a #ValentSmsWindow + * @window: a `ValentSmsWindow` * @query: query string * * Switch the search view and search for @query. @@ -928,8 +928,8 @@ valent_sms_window_search_messages (ValentSmsWindow *window, /** * valent_sms_window_set_active_message: - * @window: a #ValentSmsWindow - * @message: a #valentMessage + * @window: a `ValentSmsWindow` + * @message: a `ValentMessage` * * Set the active conversation to the thread of @message scroll to @message. */ @@ -956,7 +956,7 @@ valent_sms_window_set_active_message (ValentSmsWindow *window, /** * valent_sms_window_set_active_thread: - * @window: a #ValentSmsWindow + * @window: a `ValentSmsWindow` * @thread_id: a thread id * * Set the active conversation diff --git a/src/plugins/xdp/valent-xdp-utils.c b/src/plugins/xdp/valent-xdp-utils.c index b8eea02a91..a242878cb3 100644 --- a/src/plugins/xdp/valent-xdp-utils.c +++ b/src/plugins/xdp/valent-xdp-utils.c @@ -42,9 +42,9 @@ valent_xdp_get_active_window (void) /** * valent_xdp_get_default: * - * Get the default #XdpPortal object for Valent. + * Get the default [class@Xdp.Portal] object for Valent. * - * Returns: (transfer none): a #XdpPortal + * Returns: (transfer none): a `XdpPortal` */ XdpPortal * valent_xdp_get_default (void) diff --git a/tests/fixtures/valent-mock-channel-service.c b/tests/fixtures/valent-mock-channel-service.c index e0f377e254..cb27ac1935 100644 --- a/tests/fixtures/valent-mock-channel-service.c +++ b/tests/fixtures/valent-mock-channel-service.c @@ -160,9 +160,9 @@ valent_mock_channel_service_init (ValentMockChannelService *self) /** * valent_mock_channel_service_get_instance: * - * Get the #ValentMockChannelService instance. + * Get the `ValentMockChannelService` instance. * - * Returns: (transfer none) (nullable): a #ValentChannelService + * Returns: (transfer none) (nullable): a `ValentChannelService` */ ValentChannelService * valent_mock_channel_service_get_instance (void) @@ -173,9 +173,9 @@ valent_mock_channel_service_get_instance (void) /** * valent_mock_channel_service_get_channel: * - * Get the local #ValentChannel. + * Get the local `ValentChannel`. * - * Returns: (transfer none) (nullable): a #ValentChannel + * Returns: (transfer none) (nullable): a `ValentChannel` */ ValentChannel * valent_mock_channel_service_get_channel (void) @@ -189,9 +189,9 @@ valent_mock_channel_service_get_channel (void) /** * valent_mock_channel_service_get_endpoint: * - * Get the endpoint #ValentChannel. + * Get the endpoint `ValentChannel`. * - * Returns: (transfer none) (nullable): a #ValentChannel + * Returns: (transfer none) (nullable): a `ValentChannel` */ ValentChannel * valent_mock_channel_service_get_endpoint (void) diff --git a/tests/fixtures/valent-mock-channel.c b/tests/fixtures/valent-mock-channel.c index 532c895da8..dbc73c293e 100644 --- a/tests/fixtures/valent-mock-channel.c +++ b/tests/fixtures/valent-mock-channel.c @@ -227,7 +227,7 @@ valent_mock_channel_class_init (ValentMockChannelClass *klass) * The remote host address for the channel. * * This property only exists for tests that require a channel with a `host` - * property. The underlying connection is actually a #GUnixConnection. + * property. The underlying connection is actually a `GUnixConnection`. */ properties [PROP_HOST] = g_param_spec_string ("host", NULL, NULL, @@ -243,7 +243,7 @@ valent_mock_channel_class_init (ValentMockChannelClass *klass) * The remote host port for the channel. * * This property only exists for tests that require a channel with a `port` - * property. The underlying connection is actually a #GUnixConnection. + * property. The underlying connection is actually a `GUnixConnection`. */ properties [PROP_PORT] = g_param_spec_uint ("port", NULL, NULL, diff --git a/tests/fixtures/valent-mock-contacts-adapter.c b/tests/fixtures/valent-mock-contacts-adapter.c index fac6f8ee4a..127c5a1520 100644 --- a/tests/fixtures/valent-mock-contacts-adapter.c +++ b/tests/fixtures/valent-mock-contacts-adapter.c @@ -15,7 +15,7 @@ /** * ValentMockContactsAdapter: * - * #ValentMockContactsAdapter is a mock contact store adapter for testing + * `ValentMockContactsAdapter` is a mock contact store adapter for testing * purposes. It loads with a single contact store, with a single contact. * * The store UID and name are `mock-store' and `Mock Store`, respectively. The diff --git a/tests/fixtures/valent-mock-media-player.c b/tests/fixtures/valent-mock-media-player.c index 5a4f1e3dc7..ee3f21d015 100644 --- a/tests/fixtures/valent-mock-media-player.c +++ b/tests/fixtures/valent-mock-media-player.c @@ -313,7 +313,7 @@ valent_mock_media_player_init (ValentMockMediaPlayer *self) /** * valent_mock_media_player_update_art: - * @self: a #ValentMockMediaPlayer + * @self: a `ValentMockMediaPlayer` * @url: a URI * * Update the track metadata with album art at @uri. @@ -338,8 +338,8 @@ valent_mock_media_player_update_art (ValentMockMediaPlayer *self, /** * valent_mock_media_player_update_flags: - * @self: a #ValentMockMediaPlayer - * @flags: a #ValentMediaActions + * @self: a `ValentMockMediaPlayer` + * @flags: a `ValentMediaActions` * * Update the track metadata with album art at @uri. * diff --git a/tests/fixtures/valent-test-fixture.c b/tests/fixtures/valent-test-fixture.c index 06ee66756e..94da4d6c2b 100644 --- a/tests/fixtures/valent-test-fixture.c +++ b/tests/fixtures/valent-test-fixture.c @@ -17,7 +17,7 @@ * * A test fixture for Valent. * - * #ValentTestFixture is a fixture for tests that require a + * `ValentTestFixture` is a fixture for tests that require a * [class@Valent.Device] with a channel pair. */ G_DEFINE_BOXED_TYPE (ValentTestFixture, valent_test_fixture, @@ -48,7 +48,7 @@ valent_test_fixture_free (gpointer data) /** * valent_test_fixture_init: - * @fixture: a #ValentTestFixture + * @fixture: a `ValentTestFixture` * @user_data: a file path * * A fixture setup function. @@ -103,7 +103,7 @@ valent_test_fixture_init (ValentTestFixture *fixture, /** * valent_test_fixture_clear: - * @fixture: a #ValentTestFixture + * @fixture: a `ValentTestFixture` * @user_data: a file path * * A fixture tear-down function. @@ -138,9 +138,9 @@ valent_test_fixture_clear (ValentTestFixture *fixture, * valent_test_fixture_new: * @path: a file path * - * Create a new #ValentTestFixture for the JSON test data at @path. + * Create a new `ValentTestFixture` for the JSON test data at @path. * - * Returns: (transfer full): a new #ValentTestFixture + * Returns: (transfer full): a new `ValentTestFixture` */ ValentTestFixture * valent_test_fixture_new (const char *path) @@ -157,11 +157,11 @@ valent_test_fixture_new (const char *path) /** * valent_test_fixture_ref: - * @fixture: a #ValentTestFixture + * @fixture: a `ValentTestFixture` * * Acquire a new reference of @fixture. * - * Returns: (transfer full): a #ValentTestFixture + * Returns: (transfer full): a `ValentTestFixture` */ ValentTestFixture * valent_test_fixture_ref (ValentTestFixture *fixture) @@ -173,7 +173,7 @@ valent_test_fixture_ref (ValentTestFixture *fixture) /** * valent_test_fixture_unref: - * @fixture: a #ValentTestFixture + * @fixture: a `ValentTestFixture` * * Release a reference on @fixture. */ @@ -187,7 +187,7 @@ valent_test_fixture_unref (ValentTestFixture *fixture) /** * valent_test_fixture_get_data: - * @fixture: a #ValentTestFixture + * @fixture: a `ValentTestFixture` * * Get the arbitrary data for @fixture. * @@ -203,9 +203,9 @@ valent_test_fixture_get_data (ValentTestFixture *fixture) /** * valent_test_fixture_set_data: - * @fixture: a #ValentTestFixture + * @fixture: a `ValentTestFixture` * @data: arbitrary data pointer - * @data_free: a #GDestroyNotify + * @data_free: a `GDestroyNotify` * * Set the arbitrary data for @fixture. */ @@ -225,11 +225,11 @@ valent_test_fixture_set_data (ValentTestFixture *fixture, /** * valent_test_fixture_get_device: - * @fixture: a #ValentTestFixture + * @fixture: a `ValentTestFixture` * - * Get the #ValentDevice. + * Get the `ValentDevice`. * - * Returns: (transfer none): a #ValentDevice + * Returns: (transfer none): a `ValentDevice` */ ValentDevice * valent_test_fixture_get_device (ValentTestFixture *fixture) @@ -241,10 +241,10 @@ valent_test_fixture_get_device (ValentTestFixture *fixture) /** * valent_test_fixture_connect: - * @fixture: a #ValentTestFixture + * @fixture: a `ValentTestFixture` * @connected: whether to connect the device * - * Get the connected state of the #ValentDevice. + * Get the connected state of the `ValentDevice`. */ void valent_test_fixture_connect (ValentTestFixture *fixture, @@ -257,12 +257,12 @@ valent_test_fixture_connect (ValentTestFixture *fixture, /** * valent_test_fixture_lookup_packet: - * @fixture: a #ValentTestFixture + * @fixture: a `ValentTestFixture` * @name: a name * * Lookup the test packet @name. * - * Returns: (transfer none): a #JsonNode + * Returns: (transfer none): a `JsonNode` */ JsonNode * valent_test_fixture_lookup_packet (ValentTestFixture *fixture, @@ -276,12 +276,12 @@ valent_test_fixture_lookup_packet (ValentTestFixture *fixture, /** * valent_test_fixture_expect_packet: - * @fixture: a #ValentTestFixture + * @fixture: a `ValentTestFixture` * * Iterate the main context until a packet is received from the mock - * #ValentDevice. + * `ValentDevice`. * - * Returns: (transfer full): a #JsonNode + * Returns: (transfer full): a `JsonNode` */ JsonNode * valent_test_fixture_expect_packet (ValentTestFixture *fixture) @@ -315,10 +315,10 @@ valent_channel_write_packet_cb (GObject *object, /** * valent_test_fixture_handle_packet: - * @fixture: a #ValentTestFixture - * @packet: a #JsonNode + * @fixture: a `ValentTestFixture` + * @packet: a `JsonNode` * - * Simulate sending @packet to the #ValentDevice for @fixture. + * Simulate sending @packet to the `ValentDevice` for @fixture. */ void valent_test_fixture_handle_packet (ValentTestFixture *fixture, @@ -339,11 +339,11 @@ valent_test_fixture_handle_packet (ValentTestFixture *fixture, /** * valent_test_fixture_download: - * @fixture: a #ValentTestFixture - * @packet: a #JsonNode - * @error: (nullable): a #GError + * @fixture: a `ValentTestFixture` + * @packet: a `JsonNode` + * @error: (nullable): a `GError` * - * Simulate downloading the transfer described by @packet from the #ValentDevice + * Simulate downloading the transfer described by @packet from the `ValentDevice` * for @fixture. * * Returns: %TRUE if successful @@ -361,12 +361,12 @@ valent_test_fixture_download (ValentTestFixture *fixture, /** * valent_test_fixture_upload: - * @fixture: a #ValentTestFixture - * @packet: a #JsonNode - * @file: a #GFile - * @error: (nullable): a #GError + * @fixture: a `ValentTestFixture` + * @packet: a `JsonNode` + * @file: a `GFile` + * @error: (nullable): a `GError` * - * Simulate uploading @file to the #ValentDevice for @fixture. + * Simulate uploading @file to the `ValentDevice` for @fixture. */ gboolean valent_test_fixture_upload (ValentTestFixture *fixture, @@ -384,11 +384,11 @@ valent_test_fixture_upload (ValentTestFixture *fixture, /** * valent_test_fixture_schema_fuzz: - * @fixture: a #ValentTestFixture + * @fixture: a `ValentTestFixture` * @path: (type filename): path to a JSON Schema * * Generate test vectors for the JSON Schema at @path and pass them to the - * #ValentDevice for @fixture. + * `ValentDevice` for @fixture. */ void valent_test_fixture_schema_fuzz (ValentTestFixture *fixture, diff --git a/tests/fixtures/valent-test-utils.c b/tests/fixtures/valent-test-utils.c index ade20ee02d..38771b9cda 100644 --- a/tests/fixtures/valent-test-utils.c +++ b/tests/fixtures/valent-test-utils.c @@ -139,7 +139,7 @@ download_task (GTask *task, * @message: the message to process * @user_data: the log domain to match against * - * A #GTestLogFatalFunc for quieting fatal logging during fuzzing tests. This + * A `GTestLogFatalFunc` for quieting fatal logging during fuzzing tests. This * includes messages: * * - @log_domain is `Json` @@ -219,7 +219,7 @@ valent_test_event_push (gpointer event) * * A simple convenience to load the JSON at @path. * - * Returns: (transfer full): a #JsonNode + * Returns: (transfer full): a `JsonNode` */ JsonNode * valent_test_load_json (const char *path) @@ -243,7 +243,7 @@ valent_test_load_json (const char *path) /** * valent_test_mock_settings: * @context: a context path - * @module_name: a #PeasPluginInfo module name + * @module_name: a `PeasPluginInfo` module name * * A convenience function to create a `GSettings` object for component domain. * @@ -272,7 +272,7 @@ valent_test_await_signal_cb (gpointer data) /** * valent_test_await_adapter: - * @component: (type Valent.Component): a #ValentComponent + * @component: (type Valent.Component): a `ValentComponent` * * Wait for a [class@Valent.Component] adapter to load and return it. * @@ -452,13 +452,13 @@ valent_test_await_timeout (unsigned int duration) /** * valent_test_channel_pair: - * @identity: a #JsonNode - * @peer_identity: (nullable): a #JsonNode + * @identity: a `JsonNode` + * @peer_identity: (nullable): a `JsonNode` * * Create a pair of connected channels with @identity representing the local * device and @peer_identity representing the endpoint device. * - * Returns: (array length=2) (element-type Valent.Channel): a pair of #ValentChannel + * Returns: (array length=2) (element-type Valent.Channel): a pair of `ValentChannel` */ ValentChannel ** valent_test_channel_pair (JsonNode *identity, @@ -507,9 +507,9 @@ valent_test_channel_pair (JsonNode *identity, /** * valent_test_download: - * @channel: a #ValentChannel - * @packet: a #JsonNode - * @error: (nullable): a #GError + * @channel: a `ValentChannel` + * @packet: a `JsonNode` + * @error: (nullable): a `GError` * * Simulate downloading the payload described by @packet using @channel. * @@ -541,10 +541,10 @@ valent_test_download (ValentChannel *channel, /** * valent_test_upload: - * @channel: a #ValentChannel - * @packet: a #JsonNode - * @file: a #GFile - * @error: (nullable): a #GError + * @channel: a `ValentChannel` + * @packet: a `JsonNode` + * @file: a `GFile` + * @error: (nullable): a `GError` * * Simulate uploading @file to the endpoint of @channel. */ diff --git a/tests/fixtures/valent-test-utils.h b/tests/fixtures/valent-test-utils.h index 7d47cdb680..aa5c5ef72f 100644 --- a/tests/fixtures/valent-test-utils.h +++ b/tests/fixtures/valent-test-utils.h @@ -189,7 +189,7 @@ gboolean valent_test_upload (ValentChannel *channel, /** * v_assert_finalize_object: - * @object: (type GObject.Object): a #GObject + * @object: (type GObject.Object): a `GObject` * * Assert that @object is non-%NULL, then release one reference to it with * g_object_unref() and assert that it has been finalized (i.e. that there @@ -216,7 +216,7 @@ gboolean valent_test_upload (ValentChannel *channel, /** * v_await_finalize_object: - * @object: (type GObject.Object): a #GObject + * @object: (type GObject.Object): a `GObject` * * Assert that @object is non-%NULL, then iterate the main context until its * reference count reaches `1`. Then release one reference to it with @@ -240,7 +240,7 @@ static inline void /** * v_assert_packet_type: - * @p: a #JsonNode + * @p: a `JsonNode` * @t: a KDE Connect packet type * * Check the body object of @p for the member @m. @@ -256,7 +256,7 @@ static inline void /** * v_assert_packet_field: - * @p: a #JsonNode + * @p: a `JsonNode` * @m: a member name * * Assert the body object of @p has the member @m. @@ -271,7 +271,7 @@ static inline void /** * v_assert_packet_no_field: - * @p: a #JsonNode + * @p: a `JsonNode` * @m: a member name * * Assert the body object of @p does not have the member @m. @@ -286,7 +286,7 @@ static inline void /** * v_assert_packet_true: - * @p: a #JsonNode + * @p: a `JsonNode` * @m: a member name * * Check the body object of @p for the member @m. @@ -304,7 +304,7 @@ static inline void /** * v_assert_packet_false: - * @p: a #JsonNode + * @p: a `JsonNode` * @m: a member name * * Check the body object of @p for the member @m. @@ -322,7 +322,7 @@ static inline void /** * v_assert_packet_cmpfloat: - * @p: a #JsonNode + * @p: a `JsonNode` * @m: a member name * @cmp: comparison operator * @num: expected value @@ -344,7 +344,7 @@ static inline void /** * v_assert_packet_cmpint: - * @p: a #JsonNode + * @p: a `JsonNode` * @m: a member name * @cmp: comparison operator * @num: expected value @@ -366,7 +366,7 @@ static inline void /** * v_assert_packet_cmpstr: - * @p: a #JsonNode + * @p: a `JsonNode` * @m: a member name * @cmp: comparison operator * @str: expected value diff --git a/tests/plugins/sms/test-sms-common.h b/tests/plugins/sms/test-sms-common.h index 15b9cec125..5f1b4fe4d0 100644 --- a/tests/plugins/sms/test-sms-common.h +++ b/tests/plugins/sms/test-sms-common.h @@ -44,7 +44,7 @@ valent_test_contact_store_new_cb (ValentContactStore *store, * * Get test contact #1. * - * Returns: (transfer none): a #EContact + * Returns: (transfer none): a `EContact` */ static inline EContact * valent_test_contact1 (void) @@ -68,7 +68,7 @@ valent_test_contact1 (void) * * Get test contact #2. * - * Returns: (transfer none): a #EContact + * Returns: (transfer none): a `EContact` */ static inline EContact * valent_test_contact2 (void) @@ -92,7 +92,7 @@ valent_test_contact2 (void) * * Get test contact #3. * - * Returns: (transfer none): a #EContact + * Returns: (transfer none): a `EContact` */ static inline EContact * valent_test_contact3 (void) @@ -114,9 +114,9 @@ valent_test_contact3 (void) /** * valent_test_contact_store_new: * - * Create a new #ValentContactStore for testing. + * Create a new `ValentContactStore` for testing. * - * Returns: (transfer full): a #ValentContactStore + * Returns: (transfer full): a `ValentContactStore` */ static inline ValentContactStore * valent_test_contact_store_new (void) @@ -201,9 +201,9 @@ valent_test_sms_get_messages (void) /** * valent_test_sms_store_new: * - * Create a new #ValentSmsStore for testing. + * Create a new `ValentSmsStore` for testing. * - * Returns: (transfer full): a #ValentSmsStore + * Returns: (transfer full): a `ValentSmsStore` */ static inline ValentSmsStore * valent_test_sms_store_new (void)