diff libpurple/theme-manager.h @ 25911:0c7b74fc558e

Lots of minor whitespace and comment changes: * Removed stray whitespace * Changed a few places that used space indentation to use tabs * Changed some places that used tabs for alignment in the middle of a line of code to use spaces * Use two tabs to indent code that spans more than one line instead of a few tabs and a few spaces in an effort to align the subsequent lines with the initial one * Changed "#ifdef _BLAH_H" to "#ifdef BLAH_H" because an underscore followed by a capital letter is reserved for use by the compiler and system libraries. I also changed the path to the sound theme.xml file from root_node = xmlnode_from_file(dir, "theme.xml", "sound themes", "sound-loader"); to root_node = xmlnode_from_file(dir, "theme.xml", "sound themes", "sound-theme-loader");
author Mark Doliner <mark@kingant.net>
date Sun, 25 Jan 2009 22:55:23 +0000
parents 331a7a69d955
children b1c8ffbd48f9
line wrap: on
line diff
--- a/libpurple/theme-manager.h	Sat Jan 24 03:11:09 2009 +0000
+++ b/libpurple/theme-manager.h	Sun Jan 25 22:55:23 2009 +0000
@@ -2,7 +2,8 @@
  * @file thememanager.h  Theme Manager API
  */
 
-/* purple
+/*
+ * purple
  *
  * Purple is the legal property of its developers, whose names are too numerous
  * to list here.  Please refer to the COPYRIGHT file distributed with this
@@ -23,8 +24,8 @@
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
  */
 
-#ifndef __PURPLE_THEME_MANAGER_H__
-#define __PURPLE_THEME_MANAGER_H__
+#ifndef PURPLE_THEME_MANAGER_H
+#define PURPLE_THEME_MANAGER_H
 
 #include <glib-object.h>
 #include <glib.h>
@@ -36,12 +37,12 @@
 typedef struct _PurpleThemeManager PurpleThemeManager;
 typedef struct _PurpleThemeManagerClass PurpleThemeManagerClass;
 
-#define PURPLE_TYPE_THEME_MANAGER            (purple_theme_manager_get_type ())
+#define PURPLE_TYPE_THEME_MANAGER            (purple_theme_manager_get_type())
 #define PURPLE_THEME_MANAGER(obj)            (G_TYPE_CHECK_INSTANCE_CAST((obj), PURPLE_TYPE_THEME_MANAGER, PurpleThemeManager))
-#define PURPLE_THEME_MANAGER_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), PURPLE_TYPE_THEME_MANAGER, PurpleThemeManagerClass))
-#define PURPLE_IS_THEME_MANAGER(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), PURPLE_TYPE_THEME_MANAGER))
-#define PURPLE_IS_THEME_MANAGER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), PURPLE_TYPE_THEME_MANAGER))
-#define PURPLE_GET_THEME_MANAGER_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), PURPLE_TYPE_THEME_MANAGER, PurpleThemeManagerClass))
+#define PURPLE_THEME_MANAGER_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST((klass), PURPLE_TYPE_THEME_MANAGER, PurpleThemeManagerClass))
+#define PURPLE_IS_THEME_MANAGER(obj)         (G_TYPE_CHECK_INSTANCE_TYPE((obj), PURPLE_TYPE_THEME_MANAGER))
+#define PURPLE_IS_THEME_MANAGER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass), PURPLE_TYPE_THEME_MANAGER))
+#define PURPLE_GET_THEME_MANAGER_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS((obj), PURPLE_TYPE_THEME_MANAGER, PurpleThemeManagerClass))
 
 struct _PurpleThemeManager {
 	GObject parent;
@@ -58,68 +59,73 @@
 
 /**
  * GObject foo.
+ *
  * @internal.
  */
-GType purple_theme_manager_get_type (void);
+GType purple_theme_manager_get_type(void);
 
 /**
- * Initalizes the theme manager
+ * Initalizes the theme manager.
  */
-void purple_theme_manager_init (void);
+void purple_theme_manager_init(void);
 
 /**
- * Uninitalizes the manager then frees all the themes an loaders it is responsible for 
+ * Uninitalizes the manager then frees all the themes and loaders it is
+ * responsible for.
  */
-void purple_theme_manager_uninit (void);
+void purple_theme_manager_uninit(void);
 
 /**
- * Rebuilds all the themes in the theme manager
- * (removes all current themes but keeps the added loaders)
+ * Rebuilds all the themes in the theme manager.
+ * (Removes all current themes but keeps the added loaders.)
  */
 void purple_theme_manager_refresh(void);
 
 /**
- * Finds the PurpleTheme object stored by the theme manager
- * 
- * @param name		the name of the PurpleTheme
- * @param type 		the type of the PurpleTheme
+ * Finds the PurpleTheme object stored by the theme manager.
  *
- * @returns 	The PurpleTheme or NULL if it wasn't found
+ * @param name The name of the PurpleTheme.
+ * @param type The type of the PurpleTheme.
+ *
+ * @returns The PurpleTheme, or NULL if it wasn't found.
  */
 PurpleTheme *purple_theme_manager_find_theme(const gchar *name, const gchar *type);
 
 /**
- * Adds a PurpleTheme to the theme manager, if the theme already exits it does nothing
+ * Adds a PurpleTheme to the theme manager.  If the theme already exists
+ * then this function does nothing.
  *
- * @param theme 	the PurpleTheme to add to the manager
+ * @param theme The PurpleTheme to add to the manager.
  */
 void purple_theme_manager_add_theme(PurpleTheme *theme);
 
 /**
- * Removes a PurpleTheme from the theme manager, and frees the theme
- * @param theme 	the PurpleTheme to remove from the manager
+ * Removes a PurpleTheme from the theme manager and frees the theme.
+ *
+ * @param theme The PurpleTheme to remove from the manager.
  */
 void purple_theme_manager_remove_theme(PurpleTheme *theme);
 
 /**
- * Addes a Loader to the theme manager so it knows how to build themes
- * @param loader 	the PurpleThemeLoader to add
+ * Adds a loader to the theme manager so it knows how to build themes.
+ *
+ * @param loader The PurpleThemeLoader to add.
  */
 void purple_theme_manager_register_type(PurpleThemeLoader *loader);
 
 /**
- * Removes the loader and all themes of the same type from the loader
- * @param loader 	the PurpleThemeLoader to be removed
+ * Removes the loader and all themes of the same type from the loader.
+ *
+ * @param loader The PurpleThemeLoader to be removed.
  */
 void purple_theme_manager_unregister_type(PurpleThemeLoader *loader);
 
 /**
- * Calles the given function on each purple theme
+ * Calls the given function on each purple theme.
  *
- * @param func 		the PTFunc to be applied to each theme
+ * @param func The PTFunc to be applied to each theme.
  */
-void purple_theme_manager_for_each_theme(PTFunc func); 
+void purple_theme_manager_for_each_theme(PTFunc func);
 
 G_END_DECLS
-#endif /* __PURPLE_THEME_MANAGER_H__ */
-
+#endif /* PURPLE_THEME_MANAGER_H */