tmf/lttng: Remove unneeded (non-Javadoc) comments

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

diff --git a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/drawings/impl/FontImpl.java b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/drawings/impl/FontImpl.java
index 272b6c5d4b81bdc42b68a3325d778b107d7241f1..789dda7567f2583a06998084b9dafdf6488032cc 100755 (executable)
--- a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/drawings/impl/FontImpl.java
+++ b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/drawings/impl/FontImpl.java
@@ -1,15 +1,15 @@
 /**********************************************************************
- * Copyright (c) 2005, 2008, 2011 IBM Corporation and others.
+ * Copyright (c) 2005, 2013 IBM Corporation, 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: FontImpl.java,v 1.3 2008/01/24 02:28:50 apnan Exp $
- * 
- * Contributors: 
- * IBM - Initial API and implementation
- * Bernd Hufmann - Updated for TMF
+ *
+ * Contributors:
+ *     IBM - Initial API and implementation
+ *     Bernd Hufmann - Updated for TMF
  **********************************************************************/
+
 package org.eclipse.linuxtools.tmf.ui.views.uml2sd.drawings.impl;
 
 import org.eclipse.linuxtools.tmf.ui.views.uml2sd.drawings.IFont;
@@ -18,36 +18,72 @@ import org.eclipse.swt.graphics.FontData;
 import org.eclipse.swt.widgets.Display;
 
 /**
+ * Default implementation of the IFont interface.
+ *
+ * @version 1.0
  * @author sveyrier
- * 
+ *
  */
 public class FontImpl implements IFont {
 
-    protected Font font = null;
-    protected boolean manageFont = true;
+    // ------------------------------------------------------------------------
+    // Attributes
+    // ------------------------------------------------------------------------
+
+    /**
+     * The font object
+     */
+    protected Font fFont = null;
+    /**
+     * Flag to indicate that this object is managing the resource.
+     */
+    protected boolean fManageFont = true;
 
+    // ------------------------------------------------------------------------
+    // Constructors
+    // ------------------------------------------------------------------------
+    /**
+     * Default constructor.
+     *
+     * @param display The display to use
+     * @param data A font data
+     */
     public FontImpl(Display display, FontData data) {
-        font = new Font(display, data);
+        fFont = new Font(display, data);
     }
 
+    /**
+     * Copy constructor
+     *
+     * @param value A font to copy.
+     */
     protected FontImpl(Font value) {
-        font = value;
-        manageFont = false;
+        fFont = value;
+        fManageFont = false;
     }
 
-    @Override
-    public Object getFont() {
-        return font;
-    }
+    // ------------------------------------------------------------------------
+    // Methods
+    // ------------------------------------------------------------------------
 
+    /**
+     * Returns a font implementation based system font.
+     *
+     * @return a font implementation based system font.
+     */
     public static FontImpl getSystemFont() {
         return new FontImpl(Display.getDefault().getSystemFont());
     }
 
     @Override
-    public void dispose() {
-        if (font != null)
-            font.dispose();
+    public Object getFont() {
+        return fFont;
     }
 
+    @Override
+    public void dispose() {
+        if (fFont != null) {
+            fFont.dispose();
+        }
+    }
 }