diff --git a/pmd-jedit/PMDPlugin/PMDPlugin.props b/pmd-jedit/PMDPlugin/PMDPlugin.props
index 92d21e134f..463f84709b 100644
--- a/pmd-jedit/PMDPlugin/PMDPlugin.props
+++ b/pmd-jedit/PMDPlugin/PMDPlugin.props
@@ -3,7 +3,7 @@
#
plugin.net.sourceforge.pmd.jedit.PMDJEditPlugin.name=PMDPlugin
plugin.net.sourceforge.pmd.jedit.PMDJEditPlugin.author=Jiger Patel, Tom Copeland, Alan Ezust, Dale Anson
-plugin.net.sourceforge.pmd.jedit.PMDJEditPlugin.version=3.0.1
+plugin.net.sourceforge.pmd.jedit.PMDJEditPlugin.version=3.1
plugin.net.sourceforge.pmd.jedit.PMDJEditPlugin.docs=doc/jedit.html
plugin.net.sourceforge.pmd.jedit.PMDJEditPlugin.depend.0=jdk 1.5
plugin.net.sourceforge.pmd.jedit.PMDJEditPlugin.depend.1=jedit 04.03.03.00
diff --git a/pmd-jedit/PMDPlugin/doc/jedit.html b/pmd-jedit/PMDPlugin/doc/jedit.html
index 2b26eec473..c72eb10cd7 100644
--- a/pmd-jedit/PMDPlugin/doc/jedit.html
+++ b/pmd-jedit/PMDPlugin/doc/jedit.html
@@ -65,6 +65,10 @@ As of version 3.0, the PMD Plugin provides access to the PMD Rule Designer, whic
Release Notes & Changelog
+ 3.1 (Dale Anson)
+
+ - Display rule description along with example.
+
3.0 (Dale Anson)
- Split the option pane into smaller panes so they are easier to use.
diff --git a/pmd-jedit/PMDPlugin/src/net/sourceforge/pmd/jedit/PMDRulesOptionPane.java b/pmd-jedit/PMDPlugin/src/net/sourceforge/pmd/jedit/PMDRulesOptionPane.java
index 4c04c6e301..405b236806 100644
--- a/pmd-jedit/PMDPlugin/src/net/sourceforge/pmd/jedit/PMDRulesOptionPane.java
+++ b/pmd-jedit/PMDPlugin/src/net/sourceforge/pmd/jedit/PMDRulesOptionPane.java
@@ -25,7 +25,7 @@ public class PMDRulesOptionPane extends AbstractOptionPane implements OptionPane
SelectedRules rules;
- JTextArea exampleTextArea = new JTextArea( 15, 60 );
+ JTextArea exampleTextArea = new JTextArea( 15, 90 );
JTextField txtCustomRules;
CheckboxTree tree;
JCheckBox useDefaultRules;
@@ -144,10 +144,12 @@ public class PMDRulesOptionPane extends AbstractOptionPane implements OptionPane
Object userObject = node.getUserObject();
if ( userObject instanceof RuleNode ) {
changeExampleLabel( "Example" );
+ String description = ( ( RuleNode ) userObject ).getRule().getDescription();
+ description = description.trim();
List examples = ( ( RuleNode ) userObject ).getRule().getExamples();
exampleTextArea.setLineWrap( false );
exampleTextArea.setWrapStyleWord( false );
- exampleTextArea.setText( StringList.join( examples, "\n---------\n" ) );
+ exampleTextArea.setText( description + StringList.join( examples, "\n---------\n" ) );
exampleTextArea.setCaretPosition( 0 );
}
else if ( userObject instanceof RuleSetNode ) {