Java Doc and API clean up of TMF UML Sequence diagram framework

[deliverable/tracecompass.git] / org.eclipse.linuxtools.tmf.ui / src / org / eclipse / linuxtools / tmf / ui / views / uml2sd / ITimeCompressionListener.java

diff --git a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/ITimeCompressionListener.java b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/ITimeCompressionListener.java
index 519da066f7ad9e8a805f12b43cfc20a805dda0ed..a8f4e4012b286a0005363ba1006f5cc603ebeda5 100755 (executable)
--- a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/ITimeCompressionListener.java
+++ b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/ITimeCompressionListener.java
@@ -1,10 +1,11 @@
 /**********************************************************************
- * Copyright (c) 2005, 2006, 2011 IBM Corporation and others.
+ * Copyright (c) 2005, 2006 IBM Corporation and others.
+ * Copyright (c) 2011, 2012 Ericsson.
+ * 
  * All rights reserved.   This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License v1.0
  * which accompanies this distribution, and is available at
  * http://www.eclipse.org/legal/epl-v10.html
- * $Id: ITimeCompressionListener.java,v 1.2 2006/09/20 20:56:25 ewchan Exp $
  * 
  * Contributors: 
  * IBM - Initial API and implementation
@@ -16,11 +17,24 @@ import org.eclipse.linuxtools.tmf.ui.views.uml2sd.core.Lifeline;
 import org.eclipse.linuxtools.tmf.ui.views.uml2sd.drawings.IColor;
 
 /**
+ * <p>
+ * Listener interface for the time compression bar to notify about dela selection.
+ * </p> 
+ * 
  * @author sveyrier
+ * @version 1.0
  * 
  */
 public interface ITimeCompressionListener {
 
+    /**
+     * Notifies listeners about a selected delta.
+     * 
+     * @param lifeline The current lifeline.
+     * @param startEvent The start event selected.
+     * @param nbEvent A number of events.
+     * @param color The current color to use.
+     */
     public void deltaSelected(Lifeline lifeline, int startEvent, int nbEvent, IColor color);
 
 }