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 / handlers / provider / ISDFilterProvider.java

diff --git a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/handlers/provider/ISDFilterProvider.java b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/handlers/provider/ISDFilterProvider.java
index 2bbcce0247495896467353b85ca1c3e0dc9596d6..566f13ff587643829846ff9c5f897dd04cd083f8 100755 (executable)
--- a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/handlers/provider/ISDFilterProvider.java
+++ b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/handlers/provider/ISDFilterProvider.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: ISDFilterProvider.java,v 1.2 2006/09/20 20:56:26 ewchan Exp $
  * 
  * Contributors: 
  * IBM - Initial API and implementation
@@ -15,13 +16,18 @@ package org.eclipse.linuxtools.tmf.ui.views.uml2sd.handlers.provider;
 import java.util.List;
 
 /**
+ * Interface for providing a filter provider.
+ * 
  * Sequence Diagram loaders which implement this class provide the actions filtering the sequence diagram.<br>
  * This interface also allow the implementor to set which graph nodes are supporting filtering (thanks to
  * ISDGraphNodeSupporter extension).<br>
  * 
- * Action provider are associated to a Sequence Diagram SDWidget calling <code>SDViewer.setSDFilterProvider</code><br>
+ * Action provider are associated to a Sequence Diagram view by calling <code>SDView.setSDFilterProvider</code><br>
  * 
  * Filters to be applied to be managed by the loader in an ArrayList of FilterCriteria.<br>
+ * 
+ * @version 1.0
+ * @author sveyrier
  */
 public interface ISDFilterProvider extends ISDGraphNodeSupporter {