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 / core / LifelineCategories.java

diff --git a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/core/LifelineCategories.java b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/core/LifelineCategories.java
index 0de1ae4e35703d24e12b0ece6861125d58f38fe0..aec4753f3ffaf61f912e494716718710dc3da7be 100755 (executable)
--- a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/core/LifelineCategories.java
+++ b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/core/LifelineCategories.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: LifelineCategories.java,v 1.2 2006/09/20 20:56:25 ewchan Exp $
  * 
  * Contributors: 
  * IBM - Initial API and implementation
@@ -15,14 +16,23 @@ package org.eclipse.linuxtools.tmf.ui.views.uml2sd.core;
 import org.eclipse.linuxtools.tmf.ui.views.uml2sd.drawings.IImage;
 
 /**
+ * <p>
  * LifelineCategories is used to assign additional description for 
  * lifelines of the same type. This consists in providing a type name and an icon.
  * The icon will be displayed in the rectangle which contains the lifeline name.
  * The category name is only display in the lifeline tooltip.
+ * </p>
+ * 
+ * @version 1.0 
+ * @author sveyrier
  */
 public class LifelineCategories {
-       
-       /**
+
+    // ------------------------------------------------------------------------
+    // Attributes
+    // ------------------------------------------------------------------------
+
+    /**
         * The category name
         */
        protected String name = null;
@@ -30,9 +40,14 @@ public class LifelineCategories {
         * The category image
         */
        protected IImage categoryImage = null;
-       
+
+    // ------------------------------------------------------------------------
+    // Methods
+    // ------------------------------------------------------------------------
+
        /**
-        * Returns the category name
+        * Returns the category name.
+        * 
         * @return the category name
         */
        public String getName() {
@@ -40,7 +55,8 @@ public class LifelineCategories {
        }
 
        /**
-        * Set the category name
+        * Sets the category name.
+        * 
         * @param string the name
         */
        public void setName(String string) {
@@ -48,20 +64,20 @@ public class LifelineCategories {
        }
           
        /**
-        * Returns the category icon
+        * Returns the category icon.
+        * 
         * @return the category icon
         */
-       public IImage getImage()
-       {
+       public IImage getImage() {
                return categoryImage;
        }
        
        /**
-        * Set the category icon
+        * Sets the category icon.
+        * 
         * @param image the icon
         */
-       public void setImage(IImage image)
-       {
+       public void setImage(IImage image) {
                categoryImage = image;
        }
 }