changeset 15933:b449dc6b8a20

A little doxygen love and some tiny gaim->purpleisms
author Mark Doliner <mark@kingant.net>
date Mon, 26 Mar 2007 05:28:57 +0000
parents a26cbbd1409c
children cc3c50816cc9
files AUTHORS COPYRIGHT ChangeLog ChangeLog.API Doxyfile.in doc/PERL-HOWTO.dox libpurple/account.h libpurple/buddyicon.h libpurple/eventloop.h libpurple/notify.h libpurple/protocols/silc/README libpurple/protocols/silc/TODO libpurple/savedstatuses.h libpurple/server.h pidgin.spec.in pidgin/gtkutils.h pidgin/pidginstock.h
diffstat 17 files changed, 44 insertions(+), 49 deletions(-) [+]
line wrap: on
line diff
--- a/AUTHORS	Mon Mar 26 04:59:53 2007 +0000
+++ b/AUTHORS	Mon Mar 26 05:28:57 2007 +0000
@@ -1,10 +1,10 @@
-gaim - the Pimpin' Penguin IM Clone that's Good for the Soul
-============================================================
+Pidgin and Finch: The Pimpin' Penguin IM Clients that're Good for the Soul
+==========================================================================
 
 For a complete list of all contributors, see the COPYRIGHT file.
 
-We've got an IRC room now too, #gaim on irc.freenode.net (#wingaim for
-Windows users). Come check us out.
+We've got an IRC room now too, #pidgin on irc.freenode.net
+(#winpidgin for Windows users). Come check us out.
 
 Current Developers:
 ------------------
--- a/COPYRIGHT	Mon Mar 26 04:59:53 2007 +0000
+++ b/COPYRIGHT	Mon Mar 26 05:28:57 2007 +0000
@@ -1,8 +1,8 @@
-Gaim
+Purple, Pidgin and Finch
 Copyright (C) 1998-2007 by the following:
 
-If you have contributed to Gaim, you deserve to be on this list.
-Contact us (see: AUTHORS) and we'll add you.
+If you have contributed to this project then you deserve to be on this
+list.  Contact us (see: AUTHORS) and we'll add you.
 
 Saleem Abdulrasool
 Dave Ahlswede
--- a/ChangeLog	Mon Mar 26 04:59:53 2007 +0000
+++ b/ChangeLog	Mon Mar 26 05:28:57 2007 +0000
@@ -1,9 +1,4 @@
-2007-01-24  gettextize  <bug-gnu-gettext@gnu.org>
-
-	* Makefile.am (ACLOCAL_AMFLAGS): New variable.
-	(EXTRA_DIST): Add config.rpath, m4/ChangeLog.
-
-Gaim: The Pimpin' Penguin IM Client that's good for the soul!
+Pidgin and Finch: The Pimpin' Penguin IM Clients that're good for the soul
 
 version 2.0.0:
 	Build Changes:
--- a/ChangeLog.API	Mon Mar 26 04:59:53 2007 +0000
+++ b/ChangeLog.API	Mon Mar 26 05:28:57 2007 +0000
@@ -1,4 +1,4 @@
-Gaim: The Pimpin' Penguin IM Client that's good for the soul!
+Pidgin and Finch: The Pimpin' Penguin IM Clients that're good for the soul
 
 version 2.0.0:
 	Changed:
--- a/Doxyfile.in	Mon Mar 26 04:59:53 2007 +0000
+++ b/Doxyfile.in	Mon Mar 26 05:28:57 2007 +0000
@@ -431,9 +431,9 @@
 # directories like "/usr/src/myproject". Separate the files or directories 
 # with spaces.
 
-INPUT                  = libgaim \
-						 gtk \
-						 console \
+INPUT                  = libpurple \
+						 finch \
+						 pidgin \
                          doc
 
 # If the value of the INPUT tag contains directories, you can use the 
@@ -586,9 +586,9 @@
 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that 
 # should be ignored while generating the index headers.
 
-IGNORE_PREFIX          = Gaim \
-                         _Gaim \
-                         gaim
+IGNORE_PREFIX          = Purple \
+                         _Purple \
+                         purple
 
 #---------------------------------------------------------------------------
 # configuration options related to the HTML output
--- a/doc/PERL-HOWTO.dox	Mon Mar 26 04:59:53 2007 +0000
+++ b/doc/PERL-HOWTO.dox	Mon Mar 26 05:28:57 2007 +0000
@@ -333,7 +333,7 @@
 }
 @endcode
 
-Now we can provide an UI for manipulating these preferences in our @prefs_info
+Now we can provide an UI for manipulating these preferences in our @c prefs_info
 function.
 
 @code
--- a/libpurple/account.h	Mon Mar 26 04:59:53 2007 +0000
+++ b/libpurple/account.h	Mon Mar 26 05:28:57 2007 +0000
@@ -211,14 +211,14 @@
 /**
  * Close account requests registered for the given PurpleAccount
  *
- * @param handle	   The account for which requests should be closed
+ * @param account	   The account for which requests should be closed
  */
 void purple_account_request_close_with_account(PurpleAccount *account);
 
 /**
  * Close the account request for the given ui handle
  *
- * @param handle	   The ui specific handle for which requests should be closed
+ * @param ui_handle	   The ui specific handle for which requests should be closed
  */
 void purple_account_request_close(void *ui_handle);
 
@@ -281,7 +281,7 @@
  * Sets the account's buddy icon path.
  *
  * @param account The account.
- * @param info	  The buddy icon non-cached path.
+ * @param path	  The buddy icon non-cached path.
  */
 void purple_account_set_buddy_icon_path(PurpleAccount *account, const char *path);
 
--- a/libpurple/buddyicon.h	Mon Mar 26 04:59:53 2007 +0000
+++ b/libpurple/buddyicon.h	Mon Mar 26 05:28:57 2007 +0000
@@ -182,8 +182,8 @@
  * Returns the buddy icon's path.
  *
  * @param icon The buddy icon.
- * 
- * @preturn The buddy icon's non-cached path.
+ *
+ * @return The buddy icon's non-cached path.
  */
 const gchar *purple_buddy_icon_get_path(PurpleBuddyIcon *icon);
 
--- a/libpurple/eventloop.h	Mon Mar 26 04:59:53 2007 +0000
+++ b/libpurple/eventloop.h	Mon Mar 26 05:28:57 2007 +0000
@@ -138,7 +138,7 @@
  * implement the input_get_error UI op.
  *
  * @param fd        The input file descriptor.
- * @param errno		A pointer to an int which on return will have the error, or 0 if no error.
+ * @param error		A pointer to an int which on return will have the error, or 0 if no error.
  *
  * @return 0 if there is no error; -1 if there is an error, in which case errno will be set.
  */
--- a/libpurple/notify.h	Mon Mar 26 04:59:53 2007 +0000
+++ b/libpurple/notify.h	Mon Mar 26 05:28:57 2007 +0000
@@ -581,7 +581,7 @@
  * Set the type of a PurpleNotifyUserInfoEntry
  *
  * @param user_info_entry     The PurpleNotifyUserInfoEntry
- * @param					  The PurpleNotifyUserInfoEntryType
+ * @param type				  The PurpleNotifyUserInfoEntryType
  */
 void purple_notify_user_info_entry_set_type(PurpleNotifyUserInfoEntry *user_info_entry,
 										  PurpleNotifyUserInfoEntryType type);
--- a/libpurple/protocols/silc/README	Mon Mar 26 04:59:53 2007 +0000
+++ b/libpurple/protocols/silc/README	Mon Mar 26 05:28:57 2007 +0000
@@ -1,12 +1,12 @@
-SILC Gaim Plugin
-================
+SILC Purple Plugin
+==================
 
-This is Gaim protocol plugin of the protocol called Secure Internet Live 
-Conferencing (SILC).  The implementation will use the SILC Toolkit, 
+This is the Purple protocol plugin of the protocol called Secure Internet
+Live Conferencing (SILC).  The implementation will use the SILC Toolkit, 
 freely available from the http://silcnet.org/ site, for the actual SILC 
 protocol implementation.
 
-To include the SILC into Gaim, one needs to first compile and install 
+To include SILC into Purple, one needs to first compile and install 
 the SILC Toolkit.  It is done as follows:
 
 	./configure --enable-shared
@@ -17,7 +17,7 @@
 is not given to ./configure, the binaries are installed into the 
 /usr/local/silc directory.
 
-Once the Toolkit is installed one needs to tell for the Gaim ./configure
+Once the Toolkit is installed one needs to tell Purple's ./configure
 script where the SILC Toolkit is located.  It is done as simply as:
 
 	./configure
@@ -27,5 +27,5 @@
 	./configure --with-silc-libs=/path/to/silc/lib
 		    --with-silc-includes=/path/to/silc/include
 
-If the Toolkit cannot be located the SILC will not be compiled into the 
-Gaim.
+If the SILC Toolkit cannot be found then the SILC protocol plugin will
+not be compiled.
--- a/libpurple/protocols/silc/TODO	Mon Mar 26 04:59:53 2007 +0000
+++ b/libpurple/protocols/silc/TODO	Mon Mar 26 05:28:57 2007 +0000
@@ -2,7 +2,7 @@
 =====================
 
 Sending images
-	- Sending images to channel too, if Gaim allows it.
+	- Sending images to channel too, if libpurple allows it.
 
 Preferences
 	- Add joined channels to buddy list automatically (during
--- a/libpurple/savedstatuses.h	Mon Mar 26 04:59:53 2007 +0000
+++ b/libpurple/savedstatuses.h	Mon Mar 26 05:28:57 2007 +0000
@@ -213,9 +213,9 @@
 /**
  * Set whether accounts in Purple are idle-away or not.
  *
- * @param TRUE if accounts should be switched to use the
- *        idle-away saved status.  FALSE if they should
- *        be switched to use the default status.
+ * @param idleaway TRUE if accounts should be switched to use the
+ *                 idle-away saved status.  FALSE if they should
+ *                 be switched to use the default status.
  */
 void purple_savedstatus_set_idleaway(gboolean idleaway);
 
--- a/libpurple/server.h	Mon Mar 26 04:59:53 2007 +0000
+++ b/libpurple/server.h	Mon Mar 26 05:28:57 2007 +0000
@@ -38,7 +38,7 @@
  *
  * TODO: Could probably move this into the conversation API.
  *
- * @param typing One of PURPLE_TYPING, PURPLE_TYPED, or PURPLE_NOT_TYPING.
+ * @param state One of PURPLE_TYPING, PURPLE_TYPED, or PURPLE_NOT_TYPING.
  * @return A quiet-period, specified in seconds, where Purple will not
  *         send any additional typing notification messages.  Most
  *         protocols should return 0, which means that no additional
@@ -94,13 +94,13 @@
  * @param data The hash function should be g_str_hash() and the equal
  *             function should be g_str_equal().
  */
-void serv_join_chat(PurpleConnection *, GHashTable *);
+void serv_join_chat(PurpleConnection *, GHashTable *data);
 
 /**
  * @param data The hash function should be g_str_hash() and the equal
  *             function should be g_str_equal().
  */
-void serv_reject_chat(PurpleConnection *, GHashTable *);
+void serv_reject_chat(PurpleConnection *, GHashTable *data);
 
 /**
  * @param data The hash function should be g_str_hash() and the equal
--- a/pidgin.spec.in	Mon Mar 26 04:59:53 2007 +0000
+++ b/pidgin.spec.in	Mon Mar 26 05:28:57 2007 +0000
@@ -270,7 +270,7 @@
 if [ "$1" -gt 1 -a -n "`which gconftool-2 2>/dev/null`" ]; then
     export GCONF_CONFIG_SOURCE=`gconftool-2 --get-default-source`
     gconftool-2 --makefile-uninstall-rule \
-        %{_sysconfdir}/gconf/schemas/gaim.schemas >/dev/null || :
+        %{_sysconfdir}/gconf/schemas/purple.schemas >/dev/null || :
     killall -HUP gconfd-2 || :
 fi
 
@@ -278,7 +278,7 @@
 if [ -n "`which gconftool-2 2>/dev/null`" ]; then
     export GCONF_CONFIG_SOURCE=`gconftool-2 --get-default-source`
     gconftool-2 --makefile-install-rule \
-        %{_sysconfdir}/gconf/schemas/gaim.schemas > /dev/null || :
+        %{_sysconfdir}/gconf/schemas/purple.schemas > /dev/null || :
     killall -HUP gconfd-2 || :
 fi
 /sbin/ldconfig
@@ -287,7 +287,7 @@
 if [ "$1" -eq 0 -a -n "`which gconftool-2 2>/dev/null`" ]; then
     export GCONF_CONFIG_SOURCE=`gconftool-2 --get-default-source`
     gconftool-2 --makefile-uninstall-rule \
-      %{_sysconfdir}/gconf/schemas/gaim.schemas > /dev/null || :
+      %{_sysconfdir}/gconf/schemas/purple.schemas > /dev/null || :
     killall -HUP gconfd-2 || :
 fi
 
@@ -319,7 +319,7 @@
 %{_datadir}/sounds/pidgin/*
 %{_datadir}/applications/*
 %{_libdir}/libpurple.so.*
-%{_sysconfdir}/gconf/schemas/gaim.schemas
+%{_sysconfdir}/gconf/schemas/purple.schemas
 
 %if 0%{?_with_dbus:1}
 %{_bindir}/purple-client-example
--- a/pidgin/gtkutils.h	Mon Mar 26 04:59:53 2007 +0000
+++ b/pidgin/gtkutils.h	Mon Mar 26 05:28:57 2007 +0000
@@ -393,7 +393,7 @@
  * @param primitive  The status primitive
  * @param w          The widget to render this
  * @param size       The icon size to render at
- * @retrun A GdkPixbuf, created from stock
+ * @retun A GdkPixbuf, created from stock
  */
 GdkPixbuf * pidgin_create_status_icon(PurpleStatusPrimitive primitive, GtkWidget *w, const char *size);
 
--- a/pidgin/pidginstock.h	Mon Mar 26 04:59:53 2007 +0000
+++ b/pidgin/pidginstock.h	Mon Mar 26 05:28:57 2007 +0000
@@ -1,5 +1,5 @@
 /**
- * @file gtkstock.h GTK+ Stock resources
+ * @file pidginstock.h GTK+ Stock resources
  * @ingroup gtkui
  *
  * pidgin