/soc/2013/ankitkv/gobjectification: cb3673616d90: Added a note r...

[Ankit Vani]

Changeset: cb3673616d906bc642b36586cf7ba5528456b29d
Author:	 Ankit Vani <a at nevitus.org>
Date:	 2013-11-18 01:09 +0530
Branch:	 soc.2013.gobjectification
URL: https://hg.pidgin.im/soc/2013/ankitkv/gobjectification/rev/cb3673616d90

Description:

Added a note regarding internal.h for example plugins

diffstat:

 libpurple/plugins/dbus-example.c       |   7 ++++++-
 libpurple/plugins/debug_example.c      |   5 ++++-
 libpurple/plugins/helloworld.c         |   5 ++++-
 libpurple/plugins/notify_example.c     |   5 ++++-
 libpurple/plugins/pluginpref_example.c |  17 +++++------------
 pidgin/plugins/pidgininc.c             |  10 +++++-----
 6 files changed, 28 insertions(+), 21 deletions(-)

diffs (111 lines):

diff --git a/libpurple/plugins/dbus-example.c b/libpurple/plugins/dbus-example.c
--- a/libpurple/plugins/dbus-example.c
+++ b/libpurple/plugins/dbus-example.c
@@ -35,8 +35,13 @@
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
  */
 
+/* When writing a third-party plugin, do not include libpurple's internal.h
+ * included below. This file is for internal libpurple use only. We're including
+ * it here for our own convenience. */
 #include "internal.h"
-#include "purple.h"
+
+/* This file defines PURPLE_PLUGINS and includes all the libpurple headers */
+#include <purple.h>
 
 #include <stdio.h>
 #include <stdlib.h>
diff --git a/libpurple/plugins/debug_example.c b/libpurple/plugins/debug_example.c
--- a/libpurple/plugins/debug_example.c
+++ b/libpurple/plugins/debug_example.c
@@ -20,7 +20,10 @@
  *
  */
 
-#include <internal.h>
+/* When writing a third-party plugin, do not include libpurple's internal.h
+ * included below. This file is for internal libpurple use only. We're including
+ * it here for our own convenience. */
+#include "internal.h"
 
 /* This file defines PURPLE_PLUGINS and includes all the libpurple headers */
 #include <purple.h>
diff --git a/libpurple/plugins/helloworld.c b/libpurple/plugins/helloworld.c
--- a/libpurple/plugins/helloworld.c
+++ b/libpurple/plugins/helloworld.c
@@ -21,7 +21,10 @@
  *
  */
 
-#include <internal.h>
+/* When writing a third-party plugin, do not include libpurple's internal.h
+ * included below. This file is for internal libpurple use only. We're including
+ * it here for our own convenience. */
+#include "internal.h"
 
 /* This file defines PURPLE_PLUGINS and includes all the libpurple headers */
 #include <purple.h>
diff --git a/libpurple/plugins/notify_example.c b/libpurple/plugins/notify_example.c
--- a/libpurple/plugins/notify_example.c
+++ b/libpurple/plugins/notify_example.c
@@ -20,7 +20,10 @@
  *
  */
 
-#include <internal.h>
+/* When writing a third-party plugin, do not include libpurple's internal.h
+ * included below. This file is for internal libpurple use only. We're including
+ * it here for our own convenience. */
+#include "internal.h"
 
 /* This file defines PURPLE_PLUGINS and includes all the libpurple headers */
 #include <purple.h>
diff --git a/libpurple/plugins/pluginpref_example.c b/libpurple/plugins/pluginpref_example.c
--- a/libpurple/plugins/pluginpref_example.c
+++ b/libpurple/plugins/pluginpref_example.c
@@ -19,20 +19,13 @@
  * 02111-1301, USA.
  */
 
-#ifdef HAVE_CONFIG_H
-# include <config.h>
-#endif
-
-#ifndef PURPLE_PLUGINS
-# define PURPLE_PLUGINS
-#endif
-
+/* When writing a third-party plugin, do not include libpurple's internal.h
+ * included below. This file is for internal libpurple use only. We're including
+ * it here for our own convenience. */
 #include "internal.h"
 
-#include "plugin.h"
-#include "pluginpref.h"
-#include "prefs.h"
-#include "version.h"
+/* This file defines PURPLE_PLUGINS and includes all the libpurple headers */
+#include <purple.h>
 
 static PurplePluginPrefFrame *
 get_plugin_pref_frame(PurplePlugin *plugin) {
diff --git a/pidgin/plugins/pidgininc.c b/pidgin/plugins/pidgininc.c
--- a/pidgin/plugins/pidgininc.c
+++ b/pidgin/plugins/pidgininc.c
@@ -1,10 +1,10 @@
+/* When writing a third-party plugin, do not include libpurple's internal.h
+ * included below. This file is for internal libpurple use only. We're including
+ * it here for our own convenience. */
 #include "internal.h"
-#include "plugin.h"
 
-#include "account.h"
-#include "connection.h"
-#include "conversation.h"
-#include "version.h"
+/* This file defines PURPLE_PLUGINS and includes all the libpurple headers */
+#include <purple.h>
 
 /* include UI for pidgin_dialogs_about() */
 #include "gtkplugin.h"