[dmdirc commit] r5822 - trunk/src/com/dmdirc/plugins

[com...@dmdirc.com]

Author: greboid
Date: 2010-01-24 01:02:04 +0000 (Sun, 24 Jan 2010)
New Revision: 5822

Modified:
trunk/src/com/dmdirc/plugins/Plugin.java
Log:
Add some documentation for developers regarding pluginpreferencescategories

Git-version: 0.6.3m2-354-g3448c9a

Modified: trunk/src/com/dmdirc/plugins/Plugin.java
===================================================================
--- trunk/src/com/dmdirc/plugins/Plugin.java 2010-01-24 00:46:04 UTC (rev 5821)
+++ trunk/src/com/dmdirc/plugins/Plugin.java 2010-01-24 01:02:04 UTC (rev 5822)
@@ -32,7 +32,6 @@

/** Domain name for the settings in this plugin. */
private String myDomain = "plugin-unknown";
-
/** Has the domain been set? */
private boolean domainSet = false;

@@ -96,6 +95,9 @@

/**
* Called to allow plugins to add their configuration options to the manager.
+ * PreferencesCategories added from this method should be of type
+ * {@link com.dmdirc.config.prefs.PluginPreferencesCategory} as this gives
+ * the user feedback on the status of your plugin.
*
* @param manager The preferences manager that configuration options
* need to be added to.
@@ -114,5 +116,4 @@
public int compareTo(final Plugin o) {
return toString().compareTo(o.toString());
}
-
}