Skip to content

Commit

Permalink
refactor: drop deprecated doc formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
andyholmes committed Dec 16, 2023
1 parent 5bb980d commit cdf472c
Show file tree
Hide file tree
Showing 91 changed files with 1,066 additions and 1,067 deletions.
42 changes: 21 additions & 21 deletions src/libvalent/clipboard/valent-clipboard-adapter.c
Original file line number Diff line number Diff line change
Expand Up @@ -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.
*
Expand All @@ -41,15 +41,15 @@ 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()
* @read_bytes_finish: the virtual function pointer for valent_clipboard_adapter_read_bytes_finish()
* @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 {
Expand Down Expand Up @@ -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.
*
Expand All @@ -193,7 +193,7 @@ valent_clipboard_adapter_init (ValentClipboardAdapter *adapter)

/**
* valent_clipboard_adapter_changed: (virtual changed)
* @adapter: a #ValentClipboardAdapter
* @adapter: a `ValentClipboardAdapter`
*
* Emits [[email protected]::changed] signal on @adapter.
*
Expand All @@ -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.
*
Expand All @@ -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.
*
Expand All @@ -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.
Expand Down Expand Up @@ -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 [[email protected]_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
*/
Expand All @@ -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.
Expand Down Expand Up @@ -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 [[email protected]_bytes].
*
Expand Down
60 changes: 30 additions & 30 deletions src/libvalent/clipboard/valent-clipboard.c
Original file line number Diff line number Diff line change
Expand Up @@ -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 [[email protected]] implementations.
*
* Plugins can implement [[email protected]] to provide an interface
Expand Down Expand Up @@ -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 [[email protected]]
* changes.
Expand All @@ -206,7 +206,7 @@ valent_clipboard_init (ValentClipboard *self)
*
* Get the default [[email protected]].
*
* Returns: (transfer none) (not nullable): a #ValentClipboard
* Returns: (transfer none) (not nullable): a `ValentClipboard`
*
* Since: 1.0
*/
Expand All @@ -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.
*
Expand All @@ -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.
Expand All @@ -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.
Expand Down Expand Up @@ -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 [[email protected]_bytes].
*
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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 [[email protected]_bytes].
*
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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 [[email protected]_text].
*
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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 [[email protected]_text].
*
Expand Down
2 changes: 1 addition & 1 deletion src/libvalent/contacts/valent-contact-cache.c
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
*
* An implementation of [[email protected]].
*
* #ValentContactCache is a simple implementation of [[email protected]]
* `ValentContactCache` is a simple implementation of [[email protected]]
* for local contact store, used as a fallback when Evolution Data Server is not
* available.
*
Expand Down
Loading

0 comments on commit cdf472c

Please sign in to comment.