[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[cp-patches] FYI: API doc fixlet for javax.swing.Action
From: |
Roman Kennke |
Subject: |
[cp-patches] FYI: API doc fixlet for javax.swing.Action |
Date: |
Wed, 20 Jul 2005 11:12:48 +0200 |
User-agent: |
Mozilla Thunderbird 1.0.2 (X11/20050317) |
This fixes the API documentation for Action to be more concise.
Following the recommendations for good API docs, the class description
should not begin with 'A <classname> does this and that' but instead
'Does this and that' to avoid redundant information. This is easier to
comprehend IMO.
2005-07-20 Roman Kennke <address@hidden>
* javax/swing/Action.java:
Fixes the class description to be more concise.
/Roman
Index: javax/swing/Action.java
===================================================================
RCS file: /cvsroot/classpath/classpath/javax/swing/Action.java,v
retrieving revision 1.10
diff -u -r1.10 Action.java
--- javax/swing/Action.java 5 Jul 2005 14:57:21 -0000 1.10
+++ javax/swing/Action.java 20 Jul 2005 09:10:10 -0000
@@ -41,7 +41,7 @@
import java.beans.PropertyChangeListener;
/**
- * An action provides a convenient central point of control for some task
+ * Provides a convenient central point of control for some task
* that can be triggered by more than one control in a Swing user interface
* (for example, a menu item and a toolbar button).
*
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [cp-patches] FYI: API doc fixlet for javax.swing.Action,
Roman Kennke <=