changeset
Fix some small doc issues
Mon, 13 Nov 2023 20:52:30 -0600
- author
- Elliott Sales de Andrade <quantum.analyst@gmail.com>
- date
- Mon, 13 Nov 2023 20:52:30 -0600
- changeset 42486
- 594f84a2c97f
- parent 42485
- 15b74997e837
- child 42487
- fb5e52516ef4
Fix some small doc issues
- `Return Value` is deprecated.
- `See Also` is not a valid tag, and does not appear anywhere. If placed in the
description, then it does appear, but just like a regular paragraph, so write
it like one.
- Fix a few typos.
Testing Done:
Built docs.
Reviewed at https://reviews.imfreedom.org/r/2803/
--- a/libpurple/media/backend-iface.h Mon Nov 13 20:40:20 2023 -0600 +++ b/libpurple/media/backend-iface.h Mon Nov 13 20:52:30 2023 -0600 @@ -197,7 +197,8 @@ * * Gets the list of local candidates for a stream. * - * Return Value: (transfer full) (element-type PurpleMediaCandidate): The list of local candidates. + * Returns: (transfer full) (element-type PurpleMediaCandidate): The list of + * local candidates. * * Since: 2.7.0 */ @@ -317,7 +318,8 @@ * Gets the list of optional parameters supported by the media backend. * The list should NOT be freed. * - * Return Value: (transfer none): NULL-terminated array of names of supported parameters. + * Returns: (transfer none): NULL-terminated array of names of supported + * parameters. * * Since: 2.8.0 */
--- a/libpurple/protocols/gg/avatar.c Mon Nov 13 20:40:20 2023 -0600 +++ b/libpurple/protocols/gg/avatar.c Mon Nov 13 20:52:30 2023 -0600 @@ -241,7 +241,7 @@ * Own avatar setting. ******************************************************************************/ -/** +/* * TODO: use new, GG11 method, when IMToken will be provided by libgadu. * * POST https://avatars.mpa.gg.pl/avatars/user,<uin>/0
--- a/libpurple/purpleconversation.c Mon Nov 13 20:40:20 2023 -0600 +++ b/libpurple/purpleconversation.c Mon Nov 13 20:52:30 2023 -0600 @@ -874,7 +874,7 @@ * for a conversation to be offline if the server it is on is currently * unreachable. * - * See Also: [property@Conversation:federated]. + * See also [property@Conversation:federated]. * * Since: 3.0.0 */
--- a/libpurple/purpleconversation.h Mon Nov 13 20:40:20 2023 -0600 +++ b/libpurple/purpleconversation.h Mon Nov 13 20:52:30 2023 -0600 @@ -568,9 +568,9 @@ * * Sets everything about the topic all at once. * - * See also: [method@Conversation.set_topic], - * [method@Conversation.set_topic_author], and - * [method@Conversation.set_topic_updated]. + * See also [method@Conversation.set_topic], + * [method@Conversation.set_topic_author], and + * [method@Conversation.set_topic_updated]. * * Since: 3.0.0 */
--- a/libpurple/purplemessage.h Mon Nov 13 20:40:20 2023 -0600 +++ b/libpurple/purplemessage.h Mon Nov 13 20:52:30 2023 -0600 @@ -533,7 +533,7 @@ * * Sets whether or not @message is an action. * - * See also: [property@Message:action] for more information. + * See also [property@Message:action] for more information. * * Since: 3.0.0 */
--- a/libpurple/purplepresencemanager.h Mon Nov 13 20:40:20 2023 -0600 +++ b/libpurple/purplepresencemanager.h Mon Nov 13 20:52:30 2023 -0600 @@ -59,11 +59,11 @@ * This may be %NULL if libpurple hasn't been initialized or if someone * incorrectly unref'd it. * + * See also [func@PresenceManager.get_default_as_model]. + * * Returns: (transfer none) (nullable): The default presence manager. * * Since: 3.0.0 - * - * See Also: [func@PresenceManager.get_default_as_model] */ PURPLE_AVAILABLE_IN_3_0 PurplePresenceManager *purple_presence_manager_get_default(void); @@ -74,17 +74,17 @@ * Gets the default [class@PresenceManager] as a [iface@Gio.ListModel]. * * This is the equivalent to calling [func@PresenceManager.get_default] and - * type casting it to [iface@gio.ListModel]. + * type casting it to [iface@Gio.ListModel]. * * This may be %NULL if libpurple hasn't been initialized or if someone * incorrectly unref'd it. * + * See also [func@PresenceManager.get_default]. + * * Returns: (transfer none) (nullable): The default presence manager type cast * to a list model. * * Since: 3.0.0 - * - * See Also: [func@PresenceManager.get_default] */ PURPLE_AVAILABLE_IN_3_0 GListModel *purple_presence_manager_get_default_as_model(void);
--- a/pidgin/pidgintextbuffer.h Mon Nov 13 20:40:20 2023 -0600 +++ b/pidgin/pidgintextbuffer.h Mon Nov 13 20:52:30 2023 -0600 @@ -45,9 +45,9 @@ * This is the same as calling [func@text_buffer_get_html_range] with the start * and end iterators of @buffer. * - * Returns: (transfer full) (nullable): The HTML string, which could be empty. + * See also [func@text_buffer_get_html_range]. * - * See Also: [func@text_buffer_get_html_range] + * Returns: (transfer full) (nullable): The HTML string, which could be empty. * * Since: 3.0.0 */ @@ -64,9 +64,9 @@ * This will work with any [class@Gtk.TextBuffer] as it deciphers the tags it * finds. * - * Returns: (transfer full) (nullable): The HTML string, which could be empty. + * See also [func@text_buffer_get_html]. * - * See Also: [func@text_buffer_get_html] + * Returns: (transfer full) (nullable): The HTML string, which could be empty. * * Since: 3.0.0 */
