Updating Javadoc to prevent warnings.
Modified only methods where params or returns were defined but incorrect
Corrected param names and provided a minimal description where necessary
These descriptions may not be sufficient in some cases and should be reviewed in the future
There are MANY methods still missing JavaDoc comments.
git-svn-id: https://svn.apache.org/repos/asf/logging/chainsaw/trunk@308039 13f79535-47bb-0310-9956-ffa450edef68
diff --git a/src/java/org/apache/log4j/chainsaw/AbstractPreferencePanel.java b/src/java/org/apache/log4j/chainsaw/AbstractPreferencePanel.java
index ef45b48..7dc1f7b 100644
--- a/src/java/org/apache/log4j/chainsaw/AbstractPreferencePanel.java
+++ b/src/java/org/apache/log4j/chainsaw/AbstractPreferencePanel.java
@@ -140,7 +140,7 @@
}
/**
- * @return
+ * @return tree model
*/
protected abstract TreeModel createTreeModel();
diff --git a/src/java/org/apache/log4j/chainsaw/ApplicationPreferenceModel.java b/src/java/org/apache/log4j/chainsaw/ApplicationPreferenceModel.java
index 761a996..1a382f2 100644
--- a/src/java/org/apache/log4j/chainsaw/ApplicationPreferenceModel.java
+++ b/src/java/org/apache/log4j/chainsaw/ApplicationPreferenceModel.java
@@ -104,7 +104,7 @@
/**
* @param propertyName
- * @return
+ * @return listeners flag
*/
public boolean hasListeners(String propertyName) {
return propertySupport.hasListeners(propertyName);
@@ -156,7 +156,7 @@
}
/**
- * @param showNoReceiverWarning The showNoReceiverWarning to set.
+ * @param newShowNoReceiverWarning The showNoReceiverWarning to set.
*/
public final void setShowNoReceiverWarning(boolean newShowNoReceiverWarning) {
boolean oldShowNoReceiverWarning=showNoReceiverWarning;
@@ -208,7 +208,7 @@
/**
* Takes another model and copies all the values into this model
- * @param uncommittedPreferenceModel
+ * @param model
*/
public void apply(ApplicationPreferenceModel model)
{
@@ -237,7 +237,7 @@
return responsiveness;
}
/**
- * @param responsiveness The responsiveness to set.
+ * @param newValue The responsiveness to set.
*/
public final void setResponsiveness(int newValue)
{
@@ -394,7 +394,7 @@
}
/**
- * @return
+ * @return ok to remove security manager flag
*/
public final boolean isOkToRemoveSecurityManager() {
return this.okToRemoveSecurityManager;
diff --git a/src/java/org/apache/log4j/chainsaw/ApplicationPreferenceModelPanel.java b/src/java/org/apache/log4j/chainsaw/ApplicationPreferenceModelPanel.java
index 3d67458..b16745a 100644
--- a/src/java/org/apache/log4j/chainsaw/ApplicationPreferenceModelPanel.java
+++ b/src/java/org/apache/log4j/chainsaw/ApplicationPreferenceModelPanel.java
@@ -368,9 +368,6 @@
private final JCheckBox okToRemoveSecurityManager = new JCheckBox("Ok to remove SecurityManager");
- /**
- * @param title
- */
public GeneralAllPrefPanel() {
super("General");
diff --git a/src/java/org/apache/log4j/chainsaw/ChainsawColumns.java b/src/java/org/apache/log4j/chainsaw/ChainsawColumns.java
index 4538c76..1078ce0 100644
--- a/src/java/org/apache/log4j/chainsaw/ChainsawColumns.java
+++ b/src/java/org/apache/log4j/chainsaw/ChainsawColumns.java
@@ -79,8 +79,8 @@
/**
* Given the index which matches one of the static constants in this class, returns the resolved
* Column name as a string label.
- * @param columnIndex (not this is a 1 based collection)
- * @return
+ * @param columnIndex (note this is a 1 based collection)
+ * @return column name
*/
public static String getColumnName(int columnIndex) {
return getColumnsNames().get(columnIndex - 1).toString();
diff --git a/src/java/org/apache/log4j/chainsaw/ChainsawTabbedPane.java b/src/java/org/apache/log4j/chainsaw/ChainsawTabbedPane.java
index cfb8f37..e3b67cf 100644
--- a/src/java/org/apache/log4j/chainsaw/ChainsawTabbedPane.java
+++ b/src/java/org/apache/log4j/chainsaw/ChainsawTabbedPane.java
@@ -39,7 +39,9 @@
* and therefore no ChangeEvent is generated and sent
* to listeners. Thanks very much Sun!
*
- * @see http://developer.java.sun.com/developer/bugParade/bugs/4253819.html
+ * For more information on the issue:
+ * http://developer.java.sun.com/developer/bugParade/bugs/4253819.html
+ *
* @author Paul Smith <psmith@apache.org>
* @author Scott Deboy <sdeboy@apache.org>
*
diff --git a/src/java/org/apache/log4j/chainsaw/CheckListCellRenderer.java b/src/java/org/apache/log4j/chainsaw/CheckListCellRenderer.java
index 0fecc77..9e44a25 100644
--- a/src/java/org/apache/log4j/chainsaw/CheckListCellRenderer.java
+++ b/src/java/org/apache/log4j/chainsaw/CheckListCellRenderer.java
@@ -58,7 +58,7 @@
/**
* @param value
- * @return
+ * @return selected flag
*/
protected abstract boolean isSelected(Object value);
}
\ No newline at end of file
diff --git a/src/java/org/apache/log4j/chainsaw/EventBatchListener.java b/src/java/org/apache/log4j/chainsaw/EventBatchListener.java
index 58646a8..54f7a17 100644
--- a/src/java/org/apache/log4j/chainsaw/EventBatchListener.java
+++ b/src/java/org/apache/log4j/chainsaw/EventBatchListener.java
@@ -43,5 +43,5 @@
* @param eventBatchEntries List of ChainsawEventBatchEntry instances
* @param identifier the identifier this list of eventBatchEntrys is associated with
*/
- public void receiveEventBatch(String identifier, List eventBatchEntrys);
+ public void receiveEventBatch(String identifier, List eventBatchEntries);
}
diff --git a/src/java/org/apache/log4j/chainsaw/EventContainer.java b/src/java/org/apache/log4j/chainsaw/EventContainer.java
index 83ac4b0..2b15eed 100644
--- a/src/java/org/apache/log4j/chainsaw/EventContainer.java
+++ b/src/java/org/apache/log4j/chainsaw/EventContainer.java
@@ -114,7 +114,7 @@
/**
* Returns the total number of events currently in the model (all, not just filtered)
- * @return
+ * @return size
*/
int size();
@@ -130,7 +130,7 @@
/**
* Adds a row to the model.
- * @param row
+ * @param e event
* @param valueIsAdjusting
* @return flag representing whether or not the row is being displayed (not filtered)
*/
@@ -149,13 +149,13 @@
/**
* Sets the DisplayFilter in operation
- * @param displayFilter
+ * @param displayRule
*/
void setDisplayRule(Rule displayRule);
/**
- * Returns the index of the row
- * @param row
+ * Returns the index of the LoggingEvent
+ * @param e
*/
int getRowIndex(LoggingEvent e);
}
diff --git a/src/java/org/apache/log4j/chainsaw/LogPanelPreferenceModel.java b/src/java/org/apache/log4j/chainsaw/LogPanelPreferenceModel.java
index b38b1a9..a5163d7 100644
--- a/src/java/org/apache/log4j/chainsaw/LogPanelPreferenceModel.java
+++ b/src/java/org/apache/log4j/chainsaw/LogPanelPreferenceModel.java
@@ -72,7 +72,7 @@
/**
* Returns the Date Pattern string for the alternate date formatter.
- * @return
+ * @return date pattern
*/
public final String getDateFormatPattern() {
return dateFormatPattern;
@@ -125,23 +125,23 @@
/**
* Applies all the properties of another model to this model
*
- * @param uncommitedPreferenceModel the model to copy
+ * @param model the model to copy
* all the properties from
*/
- public void apply(LogPanelPreferenceModel that) {
- setLoggerPrecision(that.getLoggerPrecision());
- setDateFormatPattern(that.getDateFormatPattern());
- setLevelIcons(that.isLevelIcons());
- setToolTips(that.isToolTips());
- setScrollToBottom(that.isScrollToBottom());
- setDetailPaneVisible(that.isDetailPaneVisible());
- setLogTreePanelVisible(that.isLogTreePanelVisible());
+ public void apply(LogPanelPreferenceModel model) {
+ setLoggerPrecision(model.getLoggerPrecision());
+ setDateFormatPattern(model.getDateFormatPattern());
+ setLevelIcons(model.isLevelIcons());
+ setToolTips(model.isToolTips());
+ setScrollToBottom(model.isScrollToBottom());
+ setDetailPaneVisible(model.isDetailPaneVisible());
+ setLogTreePanelVisible(model.isLogTreePanelVisible());
/**
* First, iterate and ADD new columns, (this means notifications of adds go out first
* add to the end
*/
- for (Iterator iter = that.visibleColumns.iterator(); iter.hasNext();) {
+ for (Iterator iter = model.visibleColumns.iterator(); iter.hasNext();) {
String column = (String) iter.next();
if (!this.visibleColumns.contains(column)) {
@@ -160,7 +160,7 @@
for (Iterator iter = thisSet.iterator(); iter.hasNext();) {
String column = (String) iter.next();
- if (!that.visibleColumns.contains(column)) {
+ if (!model.visibleColumns.contains(column)) {
setColumnVisible(column, false);
}
}
@@ -169,14 +169,14 @@
/**
* Returns true if this the fast ISO8601DateFormat object
* should be used instead of SimpleDateFormat
- * @return
+ * @return use ISO8601 format flag
*/
public boolean isUseISO8601Format() {
return getDateFormatPattern().equals(ISO8601);
}
/**
- * @return
+ * @return level icons flag
*/
public boolean isLevelIcons() {
return levelIcons;
@@ -203,7 +203,7 @@
/**
* Returns the Logger precision.
- * @return
+ * @return logger precision
*/
public final String getLoggerPrecision() {
return loggerPrecision;
@@ -213,7 +213,7 @@
* Returns true if the named column should be made visible otherwise
* false.
* @param columnName
- * @return
+ * @return column visible flag
*/
public boolean isColumnVisible(String columnName) {
return visibleColumns.contains(columnName);
@@ -236,14 +236,14 @@
/**
* Toggles the state between visible, non-visible for a particular Column name
- * @param string
+ * @param column
*/
public void toggleColumn(String column) {
setColumnVisible(column, !isColumnVisible(column));
}
/**
- * @return
+ * @return detail pane visible flag
*/
public final boolean isDetailPaneVisible() {
return detailPaneVisible;
@@ -260,7 +260,7 @@
}
/**
- * @return
+ * @return scroll to bottom flag
*/
public final boolean isScrollToBottom() {
return scrollToBottom;
@@ -277,7 +277,7 @@
}
/**
- * @return
+ * @return tool tips enabled flag
*/
public final boolean isToolTips() {
return toolTips;
@@ -293,7 +293,7 @@
}
/**
- * @return
+ * @return log tree panel visible flag
*/
public final boolean isLogTreePanelVisible() {
return logTreePanelVisible;
@@ -310,7 +310,7 @@
}
/**
- * @return
+ * @return custom date format flag
*/
public boolean isCustomDateFormat()
{
diff --git a/src/java/org/apache/log4j/chainsaw/LogUI.java b/src/java/org/apache/log4j/chainsaw/LogUI.java
index d092613..d6f95a0 100644
--- a/src/java/org/apache/log4j/chainsaw/LogUI.java
+++ b/src/java/org/apache/log4j/chainsaw/LogUI.java
@@ -251,8 +251,8 @@
* the splash screen, and using the passed shutdown action when the user
* requests to exit the application (if null, then Chainsaw will exit the vm)
*
- * @param showSplash
- * @param shutdownAction
+ * @param model
+ * @param newShutdownAction
* DOCUMENT ME!
*/
public static void createChainsawGUI(
@@ -1503,7 +1503,7 @@
/**
* Returns the currently selected LogPanel, if there is one, otherwise null
*
- * @return
+ * @return current log panel
*/
LogPanel getCurrentLogPanel() {
Component selectedTab = getTabbedPane().getSelectedComponent();
@@ -1518,7 +1518,7 @@
}
/**
- * @param b
+ * @param visible
*/
private void setStatusBarVisible(final boolean visible) {
MessageCenter.getInstance().getLogger().debug(
@@ -1595,7 +1595,7 @@
/**
* DOCUMENT ME!
*
- * @return
+ * @return welcome panel
*/
private WelcomePanel getWelcomePanel() {
return welcomePanel;
@@ -1604,7 +1604,7 @@
/**
* DOCUMENT ME!
*
- * @return
+ * @return log tree panel visible flag
*/
public boolean isLogTreePanelVisible() {
if (getCurrentLogPanel() == null) {
diff --git a/src/java/org/apache/log4j/chainsaw/NewKeyEvent.java b/src/java/org/apache/log4j/chainsaw/NewKeyEvent.java
index 1caa7fc..607d8dc 100644
--- a/src/java/org/apache/log4j/chainsaw/NewKeyEvent.java
+++ b/src/java/org/apache/log4j/chainsaw/NewKeyEvent.java
@@ -43,21 +43,21 @@
}
/**
- * @return
+ * @return key
*/
public Object getKey() {
return key;
}
/**
- * @return
+ * @return model index
*/
public int getNewModelIndex() {
return newModelIndex;
}
/**
- * @return
+ * @return value
*/
public Object getValue() {
return value;
diff --git a/src/java/org/apache/log4j/chainsaw/NewKeyListener.java b/src/java/org/apache/log4j/chainsaw/NewKeyListener.java
index 708be00..eb9fd07 100644
--- a/src/java/org/apache/log4j/chainsaw/NewKeyListener.java
+++ b/src/java/org/apache/log4j/chainsaw/NewKeyListener.java
@@ -28,9 +28,7 @@
public interface NewKeyListener extends EventListener {
/**
- *
- * @param newModelIndex the TableModel index this new key has been assigned to
- * @param newKey the value of the Key
+ * @param e the new key event being added
*/
public void newKeyAdded(NewKeyEvent e);
}
diff --git a/src/java/org/apache/log4j/chainsaw/RuleMediator.java b/src/java/org/apache/log4j/chainsaw/RuleMediator.java
index 37cd8a9..bb313ff 100644
--- a/src/java/org/apache/log4j/chainsaw/RuleMediator.java
+++ b/src/java/org/apache/log4j/chainsaw/RuleMediator.java
@@ -129,28 +129,28 @@
}
/**
- * @return
+ * @return exclusion rule
*/
public final Rule getExclusionRule() {
return exclusionRule;
}
/**
- * @return
+ * @return inclusion rule
*/
public final Rule getInclusionRule() {
return inclusionRule;
}
/**
- * @return
+ * @return logger rule
*/
public final Rule getLoggerRule() {
return loggerRule;
}
/**
- * @return
+ * @return refinement rule
*/
public final Rule getRefinementRule() {
return refinementRule;
diff --git a/src/java/org/apache/log4j/chainsaw/TableColorizingRenderer.java b/src/java/org/apache/log4j/chainsaw/TableColorizingRenderer.java
index 2b89684..56e3994 100644
--- a/src/java/org/apache/log4j/chainsaw/TableColorizingRenderer.java
+++ b/src/java/org/apache/log4j/chainsaw/TableColorizingRenderer.java
@@ -231,7 +231,7 @@
}
/**
- * @return
+ * @return colorizer
*/
public Colorizer getColorizer() {
return colorizer;
@@ -240,7 +240,7 @@
/**
* Returns true if this renderer will use Icons to render the Level
* column, otherwise false.
- * @return
+ * @return level use icons flag
*/
public boolean isLevelUseIcons() {
return levelUseIcons;
diff --git a/src/java/org/apache/log4j/chainsaw/WelcomePanel.java b/src/java/org/apache/log4j/chainsaw/WelcomePanel.java
index fc35e5e..fb97dbd 100644
--- a/src/java/org/apache/log4j/chainsaw/WelcomePanel.java
+++ b/src/java/org/apache/log4j/chainsaw/WelcomePanel.java
@@ -153,7 +153,7 @@
}
/**
- * @return
+ * @return tooolbar
*/
public JToolBar getToolbar() {
return urlToolbar;
diff --git a/src/java/org/apache/log4j/chainsaw/color/Colorizer.java b/src/java/org/apache/log4j/chainsaw/color/Colorizer.java
index 69cf39e..efcdb3b 100644
--- a/src/java/org/apache/log4j/chainsaw/color/Colorizer.java
+++ b/src/java/org/apache/log4j/chainsaw/color/Colorizer.java
@@ -35,7 +35,7 @@
* or null if this instance cannot determine one, or that
* the stanard color should be used.
* @param event
- * @return
+ * @return background color
*/
public Color getBackgroundColor(LoggingEvent event);
diff --git a/src/java/org/apache/log4j/chainsaw/favourites/FavouritesRegistry.java b/src/java/org/apache/log4j/chainsaw/favourites/FavouritesRegistry.java
index 2558d1e..161dec7 100644
--- a/src/java/org/apache/log4j/chainsaw/favourites/FavouritesRegistry.java
+++ b/src/java/org/apache/log4j/chainsaw/favourites/FavouritesRegistry.java
@@ -21,7 +21,7 @@
* returns an object whose class is assignable from clazz, or more formally, such that
* clazz.isAssignableFrom(favourite.getPrototype().getClass())
* @param clazz
- * @return
+ * @return favourites
*/
public synchronized Collection getFavouritesByClass(Class clazz) {
throw new UnsupportedOperationException("Work In Progress");
@@ -38,7 +38,7 @@
/**
* Returns an unmodifiable List of all the known Favourite instances
- * @return
+ * @return favourites
*/
public List getFavourites() {
return Collections.unmodifiableList(favourites);
@@ -54,7 +54,6 @@
* @throws IllegalArgumentException if the prototype does not conform
* to the necessary rules to be used as a prototype (see the package documentation).
*
- * @return
*/
public void addFavourite(String name, Object prototype) {
favourites.add(createFavourite(name, prototype));
diff --git a/src/java/org/apache/log4j/chainsaw/help/HelpManager.java b/src/java/org/apache/log4j/chainsaw/help/HelpManager.java
index d243e2e..d390e19 100644
--- a/src/java/org/apache/log4j/chainsaw/help/HelpManager.java
+++ b/src/java/org/apache/log4j/chainsaw/help/HelpManager.java
@@ -73,7 +73,7 @@
}
/**
- * @return
+ * @return URL
*/
public final URL getHelpURL() {
@@ -188,7 +188,7 @@
* Determines the most appropriate Help resource for a particular class
* or returns ChainsawConstants.URL_PAGE_NOT_FOUND if there is no resource located.
*
- * @return
+ * @return URL
*/
public URL getHelpForClass(Class c) {
diff --git a/src/java/org/apache/log4j/chainsaw/helper/SwingHelper.java b/src/java/org/apache/log4j/chainsaw/helper/SwingHelper.java
index 02a82c8..1f38582 100644
--- a/src/java/org/apache/log4j/chainsaw/helper/SwingHelper.java
+++ b/src/java/org/apache/log4j/chainsaw/helper/SwingHelper.java
@@ -40,7 +40,7 @@
/**
* Centers the Component on screen.
*
- * @param dialog
+ * @param component
*/
public static void centerOnScreen(Component component) {
Dimension screenSize = Toolkit.getDefaultToolkit().getScreenSize();
diff --git a/src/java/org/apache/log4j/chainsaw/helper/TableCellEditorFactory.java b/src/java/org/apache/log4j/chainsaw/helper/TableCellEditorFactory.java
index cf8d60d..ee5523b 100644
--- a/src/java/org/apache/log4j/chainsaw/helper/TableCellEditorFactory.java
+++ b/src/java/org/apache/log4j/chainsaw/helper/TableCellEditorFactory.java
@@ -35,7 +35,7 @@
}
/**
- * @return
+ * @return table cell editor
*/
public static Object createLevelTableCellEditor()
{
diff --git a/src/java/org/apache/log4j/chainsaw/messages/MessageCenter.java b/src/java/org/apache/log4j/chainsaw/messages/MessageCenter.java
index aab828b..24e352f 100644
--- a/src/java/org/apache/log4j/chainsaw/messages/MessageCenter.java
+++ b/src/java/org/apache/log4j/chainsaw/messages/MessageCenter.java
@@ -211,7 +211,7 @@
/**
* Returns the logger that can be used to log
* messages to display within the Message Center.
- * @return
+ * @return logger
*/
public final Logger getLogger() {
return this.logger;
diff --git a/src/java/org/apache/log4j/chainsaw/prefs/SettingsListener.java b/src/java/org/apache/log4j/chainsaw/prefs/SettingsListener.java
index 3e05b08..ccd2fed 100644
--- a/src/java/org/apache/log4j/chainsaw/prefs/SettingsListener.java
+++ b/src/java/org/apache/log4j/chainsaw/prefs/SettingsListener.java
@@ -35,7 +35,6 @@
* be any arbitary thread. Having said that, it COULD be the Swing's Event
* dispatching event, but this contract makes no guarantee.
*
- * @see ProfileListener
* @author Paul Smith <psmith@apache.org>
*
*/
diff --git a/src/java/org/apache/log4j/chainsaw/prefs/SettingsManager.java b/src/java/org/apache/log4j/chainsaw/prefs/SettingsManager.java
index da84b44..689e9e6 100644
--- a/src/java/org/apache/log4j/chainsaw/prefs/SettingsManager.java
+++ b/src/java/org/apache/log4j/chainsaw/prefs/SettingsManager.java
@@ -76,7 +76,7 @@
/**
* Returns the singleton instance of the SettingsManager
- * @return
+ * @return settings manager
*/
public static final SettingsManager getInstance() {
return instance;
diff --git a/src/java/org/apache/log4j/chainsaw/receivers/NewReceiverDialogPanel.java b/src/java/org/apache/log4j/chainsaw/receivers/NewReceiverDialogPanel.java
index 278de63..aea4066 100644
--- a/src/java/org/apache/log4j/chainsaw/receivers/NewReceiverDialogPanel.java
+++ b/src/java/org/apache/log4j/chainsaw/receivers/NewReceiverDialogPanel.java
@@ -131,7 +131,7 @@
* of a NEW instance of the specified class (which must implement the Receiver
* interface)
* @param receiverClass
- * @return
+ * @return NewReceiverDialogPanel
* @throws IllegalArgumentException if the specified class is not a Receiver
*/
public static NewReceiverDialogPanel create(Class receiverClass) {
diff --git a/src/java/org/apache/log4j/chainsaw/receivers/ReceiversHelper.java b/src/java/org/apache/log4j/chainsaw/receivers/ReceiversHelper.java
index 3efaaf2..8928336 100644
--- a/src/java/org/apache/log4j/chainsaw/receivers/ReceiversHelper.java
+++ b/src/java/org/apache/log4j/chainsaw/receivers/ReceiversHelper.java
@@ -99,7 +99,7 @@
/**
* Returns an unmodifiable list of Class objects which represent all the 'known'
* Receiver classes.
- * @return
+ * @return known receiver classes
*/
public List getKnownReceiverClasses() {
return Collections.unmodifiableList(receiverClassList);
