lttng: Fix Javadoc and formatting in lttng2.ui

[deliverable/tracecompass.git] / org.eclipse.linuxtools.lttng2.ui / src / org / eclipse / linuxtools / internal / lttng2 / ui / views / control / dialogs / ImportFileInfo.java

diff --git a/org.eclipse.linuxtools.lttng2.ui/src/org/eclipse/linuxtools/internal/lttng2/ui/views/control/dialogs/ImportFileInfo.java b/org.eclipse.linuxtools.lttng2.ui/src/org/eclipse/linuxtools/internal/lttng2/ui/views/control/dialogs/ImportFileInfo.java
index 24bae8d4896c445d41142379a6a598dc73b0c977..22140a9deb39ec7192e6844fac1785e9090486e9 100644 (file)
--- a/org.eclipse.linuxtools.lttng2.ui/src/org/eclipse/linuxtools/internal/lttng2/ui/views/control/dialogs/ImportFileInfo.java
+++ b/org.eclipse.linuxtools.lttng2.ui/src/org/eclipse/linuxtools/internal/lttng2/ui/views/control/dialogs/ImportFileInfo.java
@@ -1,12 +1,12 @@
 /**********************************************************************
  * Copyright (c) 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
- * 
- * Contributors: 
+ *
+ * Contributors:
  *   Bernd Hufmann - Initial API and implementation
  **********************************************************************/
 package org.eclipse.linuxtools.internal.lttng2.ui.views.control.dialogs;
@@ -14,23 +14,39 @@ package org.eclipse.linuxtools.internal.lttng2.ui.views.control.dialogs;
 import org.eclipse.rse.subsystems.files.core.subsystems.IRemoteFile;
 
 /**
- * <b><u>ImportFileInfo</u></b>
  * <p>
  * Helper class for storing information about a remote file to import.
  * </p>
+ *
+ * @author Bernd Hufmann
  */
 public class ImportFileInfo {
 
     // ------------------------------------------------------------------------
     // Attributes
     // ------------------------------------------------------------------------
+    /**
+     * Remote file reference
+     */
     private IRemoteFile fRemoteFile;
+    /**
+     * Local Trace Name
+     */
     private String fLocalTraceName;
+    /**
+     * Global overwrite flag
+     */
     private boolean fIsOverwrite;
 
     // ------------------------------------------------------------------------
     // Constructors
     // ------------------------------------------------------------------------
+    /**
+     * Standard constructor
+     * @param file A remote file reference
+     * @param traceName A trace name
+     * @param isOverwrite global overwrite flag
+     */
     public ImportFileInfo(IRemoteFile file, String traceName, boolean isOverwrite) {
         fRemoteFile = file;
         fLocalTraceName = traceName;
@@ -61,7 +77,7 @@ public class ImportFileInfo {
     }
     /**
      * Sets the overwrite flag.
-     * @param isOverwrite
+     * @param isOverwrite If the Overwrite checkbox is checked or not
      */
     public void setOverwrite(boolean isOverwrite) {
         this.fIsOverwrite = isOverwrite;
@@ -74,7 +90,7 @@ public class ImportFileInfo {
     }
     /**
      * Sets the remote file implementation
-     * @param the remote file implementation.
+     * @param remoteFile The remote file implementation.
      */
     public void setRemoteFile(IRemoteFile remoteFile) {
         fRemoteFile = remoteFile;