sdeboy 2004/11/24 00:17:02
Modified: src/java/org/apache/log4j/spi Configurator.java
LoggingEvent.java Filter.java LoggerRepository.java
src/java/org/apache/log4j/chainsaw ChainsawTabbedPane.java
EventBatchListener.java ChainsawColumns.java
AbstractPreferencePanel.java EventContainer.java
RuleMediator.java
ApplicationPreferenceModelPanel.java
ApplicationPreferenceModel.java NewKeyEvent.java
LogUI.java LogPanelPreferenceModel.java
WelcomePanel.java NewKeyListener.java
TableColorizingRenderer.java
CheckListCellRenderer.java
src/java/org/apache/log4j/chainsaw/receivers
ReceiversHelper.java NewReceiverDialogPanel.java
src/java/org/apache/log4j FileAppender.java
src/java/org/apache/log4j/db package.html
DriverManagerConnectionSource.java
src/java/org/apache/log4j/chainsaw/help HelpManager.java
src/java/org/apache/log4j/chainsaw/messages
MessageCenter.java
src/java/org/apache/log4j/chainsaw/color Colorizer.java
src/java/org/apache/log4j/chainsaw/prefs
SettingsListener.java SettingsManager.java
src/java/org/apache/log4j/xml UtilLoggingXMLDecoder.java
XMLDecoder.java
src/java/org/apache/log4j/plugins PluginRegistry.java
src/java/org/apache/log4j/chainsaw/helper
TableCellEditorFactory.java SwingHelper.java
src/java/org/apache/log4j/net JMSAppender.java
src/java/org/apache/log4j/pattern PatternConverter.java
src/java/org/apache/log4j/chainsaw/favourites
FavouritesRegistry.java
src/java/org/apache/log4j/config ConfiguratorBase.java
Log:
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.
Revision Changes Path
1.12 +1 -1
logging-log4j/src/java/org/apache/log4j/spi/Configurator.java
Index: Configurator.java
===================================================================
RCS file:
/home/cvs/logging-log4j/src/java/org/apache/log4j/spi/Configurator.java,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -r1.11 -r1.12
--- Configurator.java 27 Feb 2004 16:47:34 -0000 1.11
+++ Configurator.java 24 Nov 2004 08:17:01 -0000 1.12
@@ -47,7 +47,7 @@
parameter.
@param url The URL to parse
- @param hierarchy The hierarchy to operation upon.
+ @param repository The repository to operate upon.
*/
void doConfigure(URL url, LoggerRepository repository);
}
1.69 +2 -1
logging-log4j/src/java/org/apache/log4j/spi/LoggingEvent.java
Index: LoggingEvent.java
===================================================================
RCS file:
/home/cvs/logging-log4j/src/java/org/apache/log4j/spi/LoggingEvent.java,v
retrieving revision 1.68
retrieving revision 1.69
diff -u -r1.68 -r1.69
--- LoggingEvent.java 22 Nov 2004 20:20:59 -0000 1.68
+++ LoggingEvent.java 24 Nov 2004 08:17:01 -0000 1.69
@@ -256,7 +256,8 @@
* at the top of this page.
* </p>
*
- * @param category The category of this event.
+ * @param fqnOfCategoryClass The category of this event.
+ * @param logger The logger
* @param timeStamp the timestamp of this logging event
* @param level The level of this event.
* @param message The message of this event.
1.8 +1 -1 logging-log4j/src/java/org/apache/log4j/spi/Filter.java
Index: Filter.java
===================================================================
RCS file: /home/cvs/logging-log4j/src/java/org/apache/log4j/spi/Filter.java,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- Filter.java 20 Nov 2004 15:13:04 -0000 1.7
+++ Filter.java 24 Nov 2004 08:17:01 -0000 1.8
@@ -97,7 +97,7 @@
the chain.
@param event The LoggingEvent to decide upon.
- @param decision The decision of the filter. */
+ */
public abstract int decide(LoggingEvent event);
/**
1.21 +0 -1
logging-log4j/src/java/org/apache/log4j/spi/LoggerRepository.java
Index: LoggerRepository.java
===================================================================
RCS file:
/home/cvs/logging-log4j/src/java/org/apache/log4j/spi/LoggerRepository.java,v
retrieving revision 1.20
retrieving revision 1.21
diff -u -r1.20 -r1.21
--- LoggerRepository.java 19 Nov 2004 15:19:07 -0000 1.20
+++ LoggerRepository.java 24 Nov 2004 08:17:01 -0000 1.21
@@ -171,7 +171,6 @@
/**
Requests that a configuration changed event be sent to any registered
[EMAIL PROTECTED] LoggerRepositoryEventListener}.
- @param logger The logger which changed levels.
@since 1.3*/
public abstract void fireConfigurationChangedEvent();
1.8 +3 -1
logging-log4j/src/java/org/apache/log4j/chainsaw/ChainsawTabbedPane.java
Index: ChainsawTabbedPane.java
===================================================================
RCS file:
/home/cvs/logging-log4j/src/java/org/apache/log4j/chainsaw/ChainsawTabbedPane.java,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- ChainsawTabbedPane.java 2 Sep 2004 00:30:19 -0000 1.7
+++ ChainsawTabbedPane.java 24 Nov 2004 08:17:01 -0000 1.8
@@ -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 <[EMAIL PROTECTED]>
* @author Scott Deboy <[EMAIL PROTECTED]>
*
1.3 +1 -1
logging-log4j/src/java/org/apache/log4j/chainsaw/EventBatchListener.java
Index: EventBatchListener.java
===================================================================
RCS file:
/home/cvs/logging-log4j/src/java/org/apache/log4j/chainsaw/EventBatchListener.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- EventBatchListener.java 27 Feb 2004 16:47:29 -0000 1.2
+++ EventBatchListener.java 24 Nov 2004 08:17:01 -0000 1.3
@@ -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);
}
1.7 +2 -2
logging-log4j/src/java/org/apache/log4j/chainsaw/ChainsawColumns.java
Index: ChainsawColumns.java
===================================================================
RCS file:
/home/cvs/logging-log4j/src/java/org/apache/log4j/chainsaw/ChainsawColumns.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- ChainsawColumns.java 12 May 2004 06:37:30 -0000 1.6
+++ ChainsawColumns.java 24 Nov 2004 08:17:01 -0000 1.7
@@ -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();
1.5 +1 -1
logging-log4j/src/java/org/apache/log4j/chainsaw/AbstractPreferencePanel.java
Index: AbstractPreferencePanel.java
===================================================================
RCS file:
/home/cvs/logging-log4j/src/java/org/apache/log4j/chainsaw/AbstractPreferencePanel.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- AbstractPreferencePanel.java 28 Mar 2004 10:04:30 -0000 1.4
+++ AbstractPreferencePanel.java 24 Nov 2004 08:17:01 -0000 1.5
@@ -140,7 +140,7 @@
}
/**
- * @return
+ * @return tree model
*/
protected abstract TreeModel createTreeModel();
1.17 +5 -5
logging-log4j/src/java/org/apache/log4j/chainsaw/EventContainer.java
Index: EventContainer.java
===================================================================
RCS file:
/home/cvs/logging-log4j/src/java/org/apache/log4j/chainsaw/EventContainer.java,v
retrieving revision 1.16
retrieving revision 1.17
diff -u -r1.16 -r1.17
--- EventContainer.java 20 Jul 2004 22:22:11 -0000 1.16
+++ EventContainer.java 24 Nov 2004 08:17:01 -0000 1.17
@@ -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);
}
1.6 +4 -4
logging-log4j/src/java/org/apache/log4j/chainsaw/RuleMediator.java
Index: RuleMediator.java
===================================================================
RCS file:
/home/cvs/logging-log4j/src/java/org/apache/log4j/chainsaw/RuleMediator.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- RuleMediator.java 27 Feb 2004 16:47:29 -0000 1.5
+++ RuleMediator.java 24 Nov 2004 08:17:01 -0000 1.6
@@ -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;
1.18 +0 -3
logging-log4j/src/java/org/apache/log4j/chainsaw/ApplicationPreferenceModelPanel.java
Index: ApplicationPreferenceModelPanel.java
===================================================================
RCS file:
/home/cvs/logging-log4j/src/java/org/apache/log4j/chainsaw/ApplicationPreferenceModelPanel.java,v
retrieving revision 1.17
retrieving revision 1.18
diff -u -r1.17 -r1.18
--- ApplicationPreferenceModelPanel.java 21 Nov 2004 07:01:26 -0000
1.17
+++ ApplicationPreferenceModelPanel.java 24 Nov 2004 08:17:01 -0000
1.18
@@ -368,9 +368,6 @@
private final JCheckBox okToRemoveSecurityManager = new JCheckBox("Ok to
remove SecurityManager");
- /**
- * @param title
- */
public GeneralAllPrefPanel() {
super("General");
1.21 +5 -5
logging-log4j/src/java/org/apache/log4j/chainsaw/ApplicationPreferenceModel.java
Index: ApplicationPreferenceModel.java
===================================================================
RCS file:
/home/cvs/logging-log4j/src/java/org/apache/log4j/chainsaw/ApplicationPreferenceModel.java,v
retrieving revision 1.20
retrieving revision 1.21
diff -u -r1.20 -r1.21
--- ApplicationPreferenceModel.java 17 Jun 2004 00:14:46 -0000 1.20
+++ ApplicationPreferenceModel.java 24 Nov 2004 08:17:01 -0000 1.21
@@ -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;
1.3 +3 -3
logging-log4j/src/java/org/apache/log4j/chainsaw/NewKeyEvent.java
Index: NewKeyEvent.java
===================================================================
RCS file:
/home/cvs/logging-log4j/src/java/org/apache/log4j/chainsaw/NewKeyEvent.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- NewKeyEvent.java 27 Feb 2004 16:47:29 -0000 1.2
+++ NewKeyEvent.java 24 Nov 2004 08:17:01 -0000 1.3
@@ -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;
1.108 +6 -6
logging-log4j/src/java/org/apache/log4j/chainsaw/LogUI.java
Index: LogUI.java
===================================================================
RCS file:
/home/cvs/logging-log4j/src/java/org/apache/log4j/chainsaw/LogUI.java,v
retrieving revision 1.107
retrieving revision 1.108
diff -u -r1.107 -r1.108
--- LogUI.java 21 Nov 2004 07:01:26 -0000 1.107
+++ LogUI.java 24 Nov 2004 08:17:01 -0000 1.108
@@ -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) {
1.12 +22 -22
logging-log4j/src/java/org/apache/log4j/chainsaw/LogPanelPreferenceModel.java
Index: LogPanelPreferenceModel.java
===================================================================
RCS file:
/home/cvs/logging-log4j/src/java/org/apache/log4j/chainsaw/LogPanelPreferenceModel.java,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -r1.11 -r1.12
--- LogPanelPreferenceModel.java 27 Feb 2004 16:47:29 -0000 1.11
+++ LogPanelPreferenceModel.java 24 Nov 2004 08:17:01 -0000 1.12
@@ -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()
{
1.10 +1 -1
logging-log4j/src/java/org/apache/log4j/chainsaw/WelcomePanel.java
Index: WelcomePanel.java
===================================================================
RCS file:
/home/cvs/logging-log4j/src/java/org/apache/log4j/chainsaw/WelcomePanel.java,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- WelcomePanel.java 27 Feb 2004 16:47:29 -0000 1.9
+++ WelcomePanel.java 24 Nov 2004 08:17:01 -0000 1.10
@@ -153,7 +153,7 @@
}
/**
- * @return
+ * @return tooolbar
*/
public JToolBar getToolbar() {
return urlToolbar;
1.3 +1 -3
logging-log4j/src/java/org/apache/log4j/chainsaw/NewKeyListener.java
Index: NewKeyListener.java
===================================================================
RCS file:
/home/cvs/logging-log4j/src/java/org/apache/log4j/chainsaw/NewKeyListener.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- NewKeyListener.java 27 Feb 2004 16:47:29 -0000 1.2
+++ NewKeyListener.java 24 Nov 2004 08:17:01 -0000 1.3
@@ -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);
}
1.16 +2 -2
logging-log4j/src/java/org/apache/log4j/chainsaw/TableColorizingRenderer.java
Index: TableColorizingRenderer.java
===================================================================
RCS file:
/home/cvs/logging-log4j/src/java/org/apache/log4j/chainsaw/TableColorizingRenderer.java,v
retrieving revision 1.15
retrieving revision 1.16
diff -u -r1.15 -r1.16
--- TableColorizingRenderer.java 26 Mar 2004 04:51:27 -0000 1.15
+++ TableColorizingRenderer.java 24 Nov 2004 08:17:01 -0000 1.16
@@ -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;
1.2 +1 -1
logging-log4j/src/java/org/apache/log4j/chainsaw/CheckListCellRenderer.java
Index: CheckListCellRenderer.java
===================================================================
RCS file:
/home/cvs/logging-log4j/src/java/org/apache/log4j/chainsaw/CheckListCellRenderer.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- CheckListCellRenderer.java 12 Dec 2003 10:30:52 -0000 1.1
+++ CheckListCellRenderer.java 24 Nov 2004 08:17:01 -0000 1.2
@@ -58,7 +58,7 @@
/**
* @param value
- * @return
+ * @return selected flag
*/
protected abstract boolean isSelected(Object value);
}
1.9 +1 -1
logging-log4j/src/java/org/apache/log4j/chainsaw/receivers/ReceiversHelper.java
Index: ReceiversHelper.java
===================================================================
RCS file:
/home/cvs/logging-log4j/src/java/org/apache/log4j/chainsaw/receivers/ReceiversHelper.java,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- ReceiversHelper.java 21 Nov 2004 07:01:26 -0000 1.8
+++ ReceiversHelper.java 24 Nov 2004 08:17:02 -0000 1.9
@@ -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);
1.5 +1 -1
logging-log4j/src/java/org/apache/log4j/chainsaw/receivers/NewReceiverDialogPanel.java
Index: NewReceiverDialogPanel.java
===================================================================
RCS file:
/home/cvs/logging-log4j/src/java/org/apache/log4j/chainsaw/receivers/NewReceiverDialogPanel.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- NewReceiverDialogPanel.java 21 Nov 2004 07:01:26 -0000 1.4
+++ NewReceiverDialogPanel.java 24 Nov 2004 08:17:02 -0000 1.5
@@ -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) {
1.46 +8 -2 logging-log4j/src/java/org/apache/log4j/FileAppender.java
Index: FileAppender.java
===================================================================
RCS file:
/home/cvs/logging-log4j/src/java/org/apache/log4j/FileAppender.java,v
retrieving revision 1.45
retrieving revision 1.46
diff -u -r1.45 -r1.46
--- FileAppender.java 22 Nov 2004 20:21:00 -0000 1.45
+++ FileAppender.java 24 Nov 2004 08:17:02 -0000 1.46
@@ -237,9 +237,15 @@
or one of its subclasses, set its properties one by one and then
call activateOptions.</b>
- @param fileName The path to the log file.
+ @param filename The path to the log file.
@param append If true will append to fileName. Otherwise will
- truncate fileName. */
+ truncate fileName.
+ @param bufferedIO
+ @param bufferSize
+
+ @throws IOException
+
+ */
public synchronized void setFile(
String filename, boolean append, boolean bufferedIO, int bufferSize)
throws IOException {
1.2 +1 -1 logging-log4j/src/java/org/apache/log4j/db/package.html
Index: package.html
===================================================================
RCS file: /home/cvs/logging-log4j/src/java/org/apache/log4j/db/package.html,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- package.html 26 May 2004 15:36:18 -0000 1.1
+++ package.html 24 Nov 2004 08:17:02 -0000 1.2
@@ -4,7 +4,7 @@
<p>The org.apache.log4j.db package provides means to append logging events
into various databases. The persisted data can be later read back using
[EMAIL PROTECTED] DBReceiver}.
[EMAIL PROTECTED] org.apache.log4j.db.DBReceiver}.
</p>
<p>Most popular database systems, such as PostgreSQL, MySQL, Oracle, DB2 and
MsSQL
1.6 +1 -1
logging-log4j/src/java/org/apache/log4j/db/DriverManagerConnectionSource.java
Index: DriverManagerConnectionSource.java
===================================================================
RCS file:
/home/cvs/logging-log4j/src/java/org/apache/log4j/db/DriverManagerConnectionSource.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- DriverManagerConnectionSource.java 24 May 2004 16:14:34 -0000
1.5
+++ DriverManagerConnectionSource.java 24 Nov 2004 08:17:02 -0000
1.6
@@ -133,7 +133,7 @@
/**
* Sets the driver class.
- * @param driver The driver to set
+ * @param driverClass The driver class to set
*/
public void setDriverClass(String driverClass) {
this.driverClass = driverClass;
1.8 +2 -2
logging-log4j/src/java/org/apache/log4j/chainsaw/help/HelpManager.java
Index: HelpManager.java
===================================================================
RCS file:
/home/cvs/logging-log4j/src/java/org/apache/log4j/chainsaw/help/HelpManager.java,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- HelpManager.java 21 Nov 2004 07:01:27 -0000 1.7
+++ HelpManager.java 24 Nov 2004 08:17:02 -0000 1.8
@@ -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) {
1.8 +1 -1
logging-log4j/src/java/org/apache/log4j/chainsaw/messages/MessageCenter.java
Index: MessageCenter.java
===================================================================
RCS file:
/home/cvs/logging-log4j/src/java/org/apache/log4j/chainsaw/messages/MessageCenter.java,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- MessageCenter.java 18 Oct 2004 22:16:34 -0000 1.7
+++ MessageCenter.java 24 Nov 2004 08:17:02 -0000 1.8
@@ -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;
1.3 +1 -1
logging-log4j/src/java/org/apache/log4j/chainsaw/color/Colorizer.java
Index: Colorizer.java
===================================================================
RCS file:
/home/cvs/logging-log4j/src/java/org/apache/log4j/chainsaw/color/Colorizer.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- Colorizer.java 27 Feb 2004 16:47:31 -0000 1.2
+++ Colorizer.java 24 Nov 2004 08:17:02 -0000 1.3
@@ -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);
1.3 +0 -1
logging-log4j/src/java/org/apache/log4j/chainsaw/prefs/SettingsListener.java
Index: SettingsListener.java
===================================================================
RCS file:
/home/cvs/logging-log4j/src/java/org/apache/log4j/chainsaw/prefs/SettingsListener.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- SettingsListener.java 27 Feb 2004 16:47:31 -0000 1.2
+++ SettingsListener.java 24 Nov 2004 08:17:02 -0000 1.3
@@ -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 <[EMAIL PROTECTED]>
*
*/
1.7 +1 -1
logging-log4j/src/java/org/apache/log4j/chainsaw/prefs/SettingsManager.java
Index: SettingsManager.java
===================================================================
RCS file:
/home/cvs/logging-log4j/src/java/org/apache/log4j/chainsaw/prefs/SettingsManager.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- SettingsManager.java 27 Jul 2004 06:48:51 -0000 1.6
+++ SettingsManager.java 24 Nov 2004 08:17:02 -0000 1.7
@@ -76,7 +76,7 @@
/**
* Returns the singleton instance of the SettingsManager
- * @return
+ * @return settings manager
*/
public static final SettingsManager getInstance() {
return instance;
1.20 +24 -24
logging-log4j/src/java/org/apache/log4j/xml/UtilLoggingXMLDecoder.java
Index: UtilLoggingXMLDecoder.java
===================================================================
RCS file:
/home/cvs/logging-log4j/src/java/org/apache/log4j/xml/UtilLoggingXMLDecoder.java,v
retrieving revision 1.19
retrieving revision 1.20
diff -u -r1.19 -r1.20
--- UtilLoggingXMLDecoder.java 22 Nov 2004 20:45:57 -0000 1.19
+++ UtilLoggingXMLDecoder.java 24 Nov 2004 08:17:02 -0000 1.20
@@ -100,7 +100,7 @@
* Converts the LoggingEvent data in XML string format into an actual
* XML Document class instance.
* @param data
- * @return
+ * @return dom document
*/
private Document parse(String data) {
if (docBuilder == null || data == null) {
@@ -144,7 +144,7 @@
/**
* Decodes a File into a Vector of LoggingEvents
- * @param file the file to decode events from
+ * @param url the url of a file containing events to decode
* @return Vector of LoggingEvents
* @throws IOException
*/
@@ -180,8 +180,8 @@
}
/**
- * Decodes a String with possibly multiple events into a Vector of
LoggingEvents
- * @param String to decode events from
+ * Decodes a String representing a number of events into a Vector of
LoggingEvents
+ * @param document to decode events from
* @return Vector of LoggingEvents
*/
public Vector decodeEvents(String document) {
@@ -190,36 +190,36 @@
if (document.equals("")) {
return null;
- } else {
- String newDoc=null;
- String newPartialEvent=null;
- //separate the string into the last portion ending with
</record> (which will
- //be processed) and the partial event which will be combined
and processed in the next section
+ }
+ String newDoc=null;
+ String newPartialEvent=null;
+ //separate the string into the last portion ending with
</record> (which will
+ //be processed) and the partial event which will be combined
and processed in the next section
+
//if the document does not contain a record end, append it to
the partial event string
if (document.lastIndexOf(RECORD_END) == -1) {
partialEvent = partialEvent + document;
return null;
}
-
- if (document.lastIndexOf(RECORD_END) + RECORD_END.length() <
document.length()) {
+
+ if (document.lastIndexOf(RECORD_END) + RECORD_END.length() <
document.length()) {
newDoc = document.substring(0, document.lastIndexOf(RECORD_END)
+ RECORD_END.length());
newPartialEvent =
document.substring(document.lastIndexOf(RECORD_END) + RECORD_END.length());
- } else {
- newDoc = document;
- }
+ } else {
+ newDoc = document;
+ }
if (partialEvent != null) {
newDoc=partialEvent + newDoc;
}
- partialEvent=newPartialEvent;
-
- Document doc = parse(newDoc);
- if (doc == null) {
- return null;
- }
- return decodeEvents(doc);
- }
- }
+ partialEvent=newPartialEvent;
+
+ Document doc = parse(newDoc);
+ if (doc == null) {
+ return null;
+ }
+ return decodeEvents(doc);
+ }
return null;
}
@@ -249,7 +249,7 @@
/**
* Given a Document, converts the XML into a Vector of LoggingEvents
* @param document
- * @return
+ * @return vector of logging events
*/
private Vector decodeEvents(Document document) {
Vector events = new Vector();
1.24 +23 -24
logging-log4j/src/java/org/apache/log4j/xml/XMLDecoder.java
Index: XMLDecoder.java
===================================================================
RCS file:
/home/cvs/logging-log4j/src/java/org/apache/log4j/xml/XMLDecoder.java,v
retrieving revision 1.23
retrieving revision 1.24
diff -u -r1.23 -r1.24
--- XMLDecoder.java 7 Sep 2004 17:16:01 -0000 1.23
+++ XMLDecoder.java 24 Nov 2004 08:17:02 -0000 1.24
@@ -102,7 +102,7 @@
* Converts the LoggingEvent data in XML string format into an actual
* XML Document class instance.
* @param data
- * @return
+ * @return dom document
*/
private Document parse(String data) {
if (docBuilder == null || data == null) {
@@ -140,7 +140,7 @@
/**
* Decodes a File into a Vector of LoggingEvents
- * @param file the file to decode events from
+ * @param url the url of a file containing events to decode
* @return Vector of LoggingEvents
* @throws IOException
*/
@@ -184,34 +184,33 @@
document = document.trim();
if (document.equals("")) {
return null;
- } else {
- String newDoc=null;
- String newPartialEvent=null;
- //separate the string into the last portion ending with
</log4j:event> (which will
- //be processed) and the partial event which will be combined
and processed in the next section
-
+ }
+ String newDoc=null;
+ String newPartialEvent=null;
+ //separate the string into the last portion ending with
</log4j:event> (which will
+ //be processed) and the partial event which will be combined
and processed in the next section
+
//if the document does not contain a record end, append it to
the partial event string
- if (document.lastIndexOf(RECORD_END) == -1) {
+ if (document.lastIndexOf(RECORD_END) == -1) {
partialEvent = partialEvent + document;
- return null;
- }
-
- if (document.lastIndexOf(RECORD_END) + RECORD_END.length() <
document.length()) {
+ return null;
+ }
+
+ if (document.lastIndexOf(RECORD_END) + RECORD_END.length() <
document.length()) {
newDoc = document.substring(0, document.lastIndexOf(RECORD_END)
+ RECORD_END.length());
newPartialEvent =
document.substring(document.lastIndexOf(RECORD_END) + RECORD_END.length());
- } else {
- newDoc = document;
- }
+ } else {
+ newDoc = document;
+ }
if (partialEvent != null) {
newDoc=partialEvent + newDoc;
}
- partialEvent=newPartialEvent;
- Document doc = parse(newDoc);
- if (doc == null) {
- return null;
- }
- return decodeEvents(doc);
- }
+ partialEvent=newPartialEvent;
+ Document doc = parse(newDoc);
+ if (doc == null) {
+ return null;
+ }
+ return decodeEvents(doc);
}
return null;
}
@@ -242,7 +241,7 @@
/**
* Given a Document, converts the XML into a Vector of LoggingEvents
* @param document
- * @return
+ * @return Vector of LoggingEvents
*/
private Vector decodeEvents(Document document) {
Vector events = new Vector();
1.14 +2 -5
logging-log4j/src/java/org/apache/log4j/plugins/PluginRegistry.java
Index: PluginRegistry.java
===================================================================
RCS file:
/home/cvs/logging-log4j/src/java/org/apache/log4j/plugins/PluginRegistry.java,v
retrieving revision 1.13
retrieving revision 1.14
diff -u -r1.13 -r1.14
--- PluginRegistry.java 25 May 2004 04:45:22 -0000 1.13
+++ PluginRegistry.java 24 Nov 2004 08:17:02 -0000 1.14
@@ -65,7 +65,6 @@
* an existing Plugin registered within the scope of the specified
* LoggerRepository.
* @param name The name to check the repository for
- * @param repository the repository to check the name against
* @return true if the name is already in use, otherwise false
*/
public boolean pluginNameExists(String name) {
@@ -142,7 +141,6 @@
/**
* Returns all the plugins for a given repository.
*
- * @param repository the logger repository to get the plugins from.
* @return List list of plugins from the repository.
*/
public List getPlugins() {
@@ -162,7 +160,6 @@
Returns all the plugins for a given repository that are instances
of a certain class.
- @param repository the logger repository to get the plugins from.
@param pluginClass the class the plugin must implement to be selected.
@return List list of plugins from the repository. */
public List getPlugins(Class pluginClass) {
@@ -186,7 +183,6 @@
Stops a plugin by plugin name and repository.
@param pluginName the name of the plugin to stop.
- @param repository the repository the plugin should be attached to.
@return Plugin the plugin, if stopped, or null if the
the plugin was not found in the registry. */
public Plugin stopPlugin(String pluginName) {
@@ -212,7 +208,8 @@
/**
Stops all plugins in the given logger repository.
- @param repository the logger repository to stop all plugins for. */
+
+ */
public void stopAllPlugins() {
synchronized (pluginMap) {
// remove the listener for this repository
1.2 +1 -1
logging-log4j/src/java/org/apache/log4j/chainsaw/helper/TableCellEditorFactory.java
Index: TableCellEditorFactory.java
===================================================================
RCS file:
/home/cvs/logging-log4j/src/java/org/apache/log4j/chainsaw/helper/TableCellEditorFactory.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- TableCellEditorFactory.java 19 Dec 2003 03:20:31 -0000 1.1
+++ TableCellEditorFactory.java 24 Nov 2004 08:17:02 -0000 1.2
@@ -35,7 +35,7 @@
}
/**
- * @return
+ * @return table cell editor
*/
public static Object createLevelTableCellEditor()
{
1.4 +1 -1
logging-log4j/src/java/org/apache/log4j/chainsaw/helper/SwingHelper.java
Index: SwingHelper.java
===================================================================
RCS file:
/home/cvs/logging-log4j/src/java/org/apache/log4j/chainsaw/helper/SwingHelper.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- SwingHelper.java 27 Feb 2004 16:47:31 -0000 1.3
+++ SwingHelper.java 24 Nov 2004 08:17:02 -0000 1.4
@@ -40,7 +40,7 @@
/**
* Centers the Component on screen.
*
- * @param dialog
+ * @param component
*/
public static void centerOnScreen(Component component) {
Dimension screenSize = Toolkit.getDefaultToolkit().getScreenSize();
1.17 +3 -3
logging-log4j/src/java/org/apache/log4j/net/JMSAppender.java
Index: JMSAppender.java
===================================================================
RCS file:
/home/cvs/logging-log4j/src/java/org/apache/log4j/net/JMSAppender.java,v
retrieving revision 1.16
retrieving revision 1.17
diff -u -r1.16 -r1.17
--- JMSAppender.java 20 Nov 2004 15:13:05 -0000 1.16
+++ JMSAppender.java 24 Nov 2004 08:17:02 -0000 1.17
@@ -39,9 +39,9 @@
/**
* A simple appender that publishes events to a JMS Topic. The events
* are serialized and transmitted as JMS message type [EMAIL PROTECTED]
- * ObjectMessage}.
+ * javax.jms.ObjectMessage}.
- * <p>JMS [EMAIL PROTECTED] Topic topics} and [EMAIL PROTECTED]
TopicConnectionFactory topic
+ * <p>JMS [EMAIL PROTECTED] javax.jmx.Topic topics} and [EMAIL PROTECTED]
javax.jmx.TopicConnectionFactory topic
* connection factories} are administered objects that are retrieved
* using JNDI messaging which in turn requires the retreival of a JNDI
* [EMAIL PROTECTED] Context}.
@@ -369,7 +369,7 @@
/**
* The user name to use when [EMAIL PROTECTED]
- * TopicConnectionFactory#createTopicConnection(String, String)
+ * javax.jms.TopicConnectionFactory#createTopicConnection(String, String)}
* creating a topic session}. If you set this option, you should
* also set the <b>Password</b> option. See [EMAIL PROTECTED]
* #setPassword(String)}.
1.11 +1 -1
logging-log4j/src/java/org/apache/log4j/pattern/PatternConverter.java
Index: PatternConverter.java
===================================================================
RCS file:
/home/cvs/logging-log4j/src/java/org/apache/log4j/pattern/PatternConverter.java,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -r1.10 -r1.11
--- PatternConverter.java 22 Nov 2004 20:21:02 -0000 1.10
+++ PatternConverter.java 24 Nov 2004 08:17:02 -0000 1.11
@@ -144,7 +144,7 @@
*
* This information is currently used only by HTMLLayout.
*
- * @param LoggingEvent null values are accepted
+ * @param e null values are accepted
* @return the name of the conversion pattern
*/
public abstract String getStyleClass(LoggingEvent e);
1.3 +2 -3
logging-log4j/src/java/org/apache/log4j/chainsaw/favourites/FavouritesRegistry.java
Index: FavouritesRegistry.java
===================================================================
RCS file:
/home/cvs/logging-log4j/src/java/org/apache/log4j/chainsaw/favourites/FavouritesRegistry.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- FavouritesRegistry.java 28 Mar 2004 10:04:31 -0000 1.2
+++ FavouritesRegistry.java 24 Nov 2004 08:17:02 -0000 1.3
@@ -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));
1.7 +0 -1
logging-log4j/src/java/org/apache/log4j/config/ConfiguratorBase.java
Index: ConfiguratorBase.java
===================================================================
RCS file:
/home/cvs/logging-log4j/src/java/org/apache/log4j/config/ConfiguratorBase.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- ConfiguratorBase.java 23 Nov 2004 16:32:17 -0000 1.6
+++ ConfiguratorBase.java 24 Nov 2004 08:17:02 -0000 1.7
@@ -129,7 +129,6 @@
/**
* Dump any errors on System.out.
- * @param errorList
*/
public void dumpErrors() {
List errorList = getErrorList();
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
