summaryrefslogtreecommitdiff
path: root/libpurple/protocols.h
diff options
context:
space:
mode:
authorAnkit Vani <a@nevitus.org>2014-01-29 10:01:14 +0530
committerAnkit Vani <a@nevitus.org>2014-01-29 10:01:14 +0530
commit40d666558254fb6d95ed359144486544a59f358c (patch)
tree02f272ddc8e1c4ac9d9acf37a53feb42aab1d157 /libpurple/protocols.h
parent84cc113755ed131a3e496e6e5fdc10c505fa1720 (diff)
downloadpidgin-40d666558254fb6d95ed359144486544a59f358c.tar.gz
Use gtk-doc style constants (%NULL, %TRUE, %FALSE), and 'Note:' instead of '@note'
Diffstat (limited to 'libpurple/protocols.h')
-rw-r--r--libpurple/protocols.h12
1 files changed, 6 insertions, 6 deletions
diff --git a/libpurple/protocols.h b/libpurple/protocols.h
index 064bbfd841..be0d8ae5e7 100644
--- a/libpurple/protocols.h
+++ b/libpurple/protocols.h
@@ -242,7 +242,7 @@ void purple_attention_type_set_outgoing_desc(PurpleAttentionType *type, const ch
*
* @type: The attention type.
* @name: The icon's name.
- * @note Icons are optional for attention events.
+ * Note: Icons are optional for attention events.
*/
void purple_attention_type_set_icon_name(PurpleAttentionType *type, const char *name);
@@ -285,8 +285,8 @@ const char *purple_attention_type_get_outgoing_desc(const PurpleAttentionType *t
* Get the attention type's icon name.
*
* @type: The attention type.
- * Returns: The icon name or @c NULL if unset/empty.
- * @note Icons are optional for attention events.
+ * Returns: The icon name or %NULL if unset/empty.
+ * Note: Icons are optional for attention events.
*/
const char *purple_attention_type_get_icon_name(const PurpleAttentionType *type);
@@ -581,10 +581,10 @@ PurpleProtocol *purple_protocols_find(const char *id);
* Adds a protocol to the list of protocols.
*
* @protocol_type: The type of the protocol to add.
- * @error: Return location for a #GError or @c NULL. If provided, this
+ * @error: Return location for a #GError or %NULL. If provided, this
* will be set to the reason if adding fails.
*
- * Returns: The protocol instance if the protocol was added, else @c NULL.
+ * Returns: The protocol instance if the protocol was added, else %NULL.
*/
PurpleProtocol *purple_protocols_add(GType protocol_type, GError **error);
@@ -594,7 +594,7 @@ PurpleProtocol *purple_protocols_add(GType protocol_type, GError **error);
* and protocol options.
*
* @protocol: The protocol to remove.
- * @error: Return location for a #GError or @c NULL. If provided, this
+ * @error: Return location for a #GError or %NULL. If provided, this
* will be set to the reason if removing fails.
*
* Returns: TRUE if the protocol was removed, else FALSE.