/soc/2013/ankitkv/gobjectification: 5bbf6d7050d8: Document the A...

[Ankit Vani]

Changeset: 5bbf6d7050d8a3b974f32b3abf91c0dd141535be
Author:	 Ankit Vani <a at nevitus.org>
Date:	 2014-01-20 01:33 +0530
Branch:	 soc.2013.gobjectification.plugins
URL: https://hg.pidgin.im/soc/2013/ankitkv/gobjectification/rev/5bbf6d7050d8

Description:

Document the ABI version bitwise magic

diffstat:

 libpurple/plugins.h |  7 ++++++-
 1 files changed, 6 insertions(+), 1 deletions(-)

diffs (17 lines):

diff --git a/libpurple/plugins.h b/libpurple/plugins.h
--- a/libpurple/plugins.h
+++ b/libpurple/plugins.h
@@ -156,7 +156,12 @@ struct _PurplePluginAction {
 	gpointer user_data;
 };
 
-/** Returns an ABI version to set in plugins using major and minor versions */
+/**
+ * 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.
+ */
 #define PURPLE_PLUGIN_ABI_VERSION(major,minor) \
 	(0x01000000 | ((major) << 16) | (minor))