/soc/2013/ankitkv/gobjectification: 5cf27e3320e1: Fix some gtk-d...

[Ankit Vani]

Changeset: 5cf27e3320e1416c319a4a5a590efb4ce6a93b1c
Author:	 Ankit Vani <a at nevitus.org>
Date:	 2014-02-07 15:24 +0530
Branch:	 soc.2013.gobjectification.plugins
URL: https://hg.pidgin.im/soc/2013/ankitkv/gobjectification/rev/5cf27e3320e1

Description:

Fix some gtk-doc warnings

diffstat:

 libpurple/buddyicon.h    |   4 ++--
 libpurple/conversation.h |   2 +-
 libpurple/plugins.h      |  17 +++++++++--------
 libpurple/protocol.h     |   2 +-
 libpurple/protocols.c    |   2 +-
 libpurple/protocols.h    |   4 ++--
 6 files changed, 16 insertions(+), 15 deletions(-)

diffs (154 lines):

diff --git a/libpurple/buddyicon.h b/libpurple/buddyicon.h
--- a/libpurple/buddyicon.h
+++ b/libpurple/buddyicon.h
@@ -467,7 +467,7 @@ void purple_buddy_icons_uninit(void);
 /**
  * purple_buddy_icon_spec_get_type:
  *
- * Returns the GType for the #PurpleBuddyIconSpec boxed structure.
+ * Returns: The #GType for the #PurpleBuddyIconSpec boxed structure.
  */
 GType purple_buddy_icon_spec_get_type(void);
 
@@ -502,4 +502,4 @@ void purple_buddy_icon_spec_get_scaled_s
 
 G_END_DECLS
 
-#endif /* _PURPLE_BUDDYICON_H_ */
\ No newline at end of file
+#endif /* _PURPLE_BUDDYICON_H_ */
diff --git a/libpurple/conversation.h b/libpurple/conversation.h
--- a/libpurple/conversation.h
+++ b/libpurple/conversation.h
@@ -719,7 +719,7 @@ gboolean purple_conversation_do_command(
  *
  * Gets the maximum message size in bytes for the conversation.
  *
- * See #PurplePluginProtocolInfo's #get_max_message_size
+ * See #PurpleProtocolClientIface.get_max_message_size
  *
  * Returns: Maximum message size, 0 if unspecified, -1 for infinite.
  */
diff --git a/libpurple/plugins.h b/libpurple/plugins.h
--- a/libpurple/plugins.h
+++ b/libpurple/plugins.h
@@ -132,6 +132,7 @@ struct _PurplePluginInfo {
 	GObject parent;
 #endif
 
+	/*< public >*/
 	gpointer ui_data;
 };
 
@@ -170,10 +171,10 @@ struct _PurplePluginAction {
 /**
  * PURPLE_PLUGIN_ABI_VERSION:
  *
- * Returns an ABI version to set in plugins using major and minor versions.
- *
  * Note: The lower six nibbles represent the ABI version for libpurple, the
  *       rest are required by GPlugin.
+ *
+ * Returns: An ABI version to set in plugins using major and minor versions.
  */
 #define PURPLE_PLUGIN_ABI_VERSION(major,minor) \
 	(0x01000000 | ((major) << 16) | (minor))
@@ -181,7 +182,7 @@ struct _PurplePluginAction {
 /**
  * PURPLE_PLUGIN_ABI_MAJOR_VERSION:
  *
- * Returns the major version from an ABI version
+ * Returns: The major version from an ABI version
  */
 #define PURPLE_PLUGIN_ABI_MAJOR_VERSION(abi) \
 	((abi >> 16) & 0xff)
@@ -189,7 +190,7 @@ struct _PurplePluginAction {
 /**
  * PURPLE_PLUGIN_ABI_MINOR_VERSION:
  *
- * Returns the minor version from an ABI version
+ * Returns: The minor version from an ABI version
  */
 #define PURPLE_PLUGIN_ABI_MINOR_VERSION(abi) \
 	(abi & 0xffff)
@@ -455,7 +456,7 @@ gboolean purple_plugin_is_loaded(const P
 
 /**
  * purple_plugin_get_filename:
- * @info: The plugin.
+ * @plugin: The plugin.
  *
  * Returns a plugin's filename, along with the path.
  *
@@ -465,7 +466,7 @@ const gchar *purple_plugin_get_filename(
 
 /**
  * purple_plugin_get_info:
- * @info: The plugin.
+ * @plugin: The plugin.
  *
  * Returns a plugin's #PurplePluginInfo instance.
  *
@@ -561,7 +562,7 @@ GType purple_plugin_info_get_type(void);
  *             name/value pairs, followed by %NULL
  *
  * Creates a new #PurplePluginInfo instance to be returned from
- * gplugin_plugin_query() of a plugin, using the provided name/value pairs.
+ * #plugin_query of a plugin, using the provided name/value pairs.
  *
  * All properties except <literal>"id"</literal> and
  * <literal>"purple-abi"</literal> are optional.
@@ -604,7 +605,7 @@ GType purple_plugin_info_get_type(void);
  *   <row><entry><literal>"license-id"</literal></entry>
  *     <entry>(string) Short name of the plugin's license. This should
  *       either be an identifier of the license from
- *       <ulink url="http://dep.debian.net/deps/dep5/#license-specification"/>
+ *       <ulink url="http://dep.debian.net/deps/dep5/#license-specification" />
  *       or "Other" for custom licenses.</entry>
  *   </row>
  *   <row><entry><literal>"license-text"</literal></entry>
diff --git a/libpurple/protocol.h b/libpurple/protocol.h
--- a/libpurple/protocol.h
+++ b/libpurple/protocol.h
@@ -775,7 +775,7 @@ struct _PurpleProtocolFactoryIface
 /**
  * PURPLE_PROTOCOL_IMPLEMENTS:
  * @protocol: The protocol in which to check
- * @IFACE:    The interface name in caps. e.g. %CLIENT_IFACE
+ * @IFACE:    The interface name in caps. e.g. #CLIENT_IFACE
  * @func:     The function to check
  *
  * Returns: %TRUE if a protocol implements a function in an interface,
diff --git a/libpurple/protocols.c b/libpurple/protocols.c
--- a/libpurple/protocols.c
+++ b/libpurple/protocols.c
@@ -742,7 +742,7 @@ purple_protocol_action_get_type(void)
 /**************************************************************************
  * Protocols API
  **************************************************************************/
-/**
+/*
  * Negative if a before b, 0 if equal, positive if a after b.
  */
 static gint
diff --git a/libpurple/protocols.h b/libpurple/protocols.h
--- a/libpurple/protocols.h
+++ b/libpurple/protocols.h
@@ -386,7 +386,7 @@ void purple_protocol_got_account_login_t
  * @account:   The account the user is on.
  * @status_id: The status ID.
  * @...:       A NULL-terminated list of attribute IDs and values,
- *             beginning with the value for %attr_id.
+ *             beginning with the value for #attr_id.
  *
  * Notifies Purple that our account's status has changed.
  *
@@ -583,7 +583,7 @@ void purple_protocol_got_media_caps(Purp
  *
  * Gets the safe maximum message size in bytes for the protocol.
  *
- * See #PurpleProtocol.get_max_message_size
+ * See #PurpleProtocolClientIface.get_max_message_size
  *
  * Returns: Maximum message size, 0 if unspecified, -1 for infinite.
  */