tmf: Fix some javadoc warnings in tmf.core

[deliverable/tracecompass.git] / org.eclipse.linuxtools.tmf.core / src / org / eclipse / linuxtools / tmf / core / event / ITmfEventField.java

diff --git a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/event/ITmfEventField.java b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/event/ITmfEventField.java
index 7efb44dfaf485a69b4f57cbe1a1b896a42251c27..7782b672c788eadef9f7ad63676150f4559e5742 100644 (file)
--- a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/event/ITmfEventField.java
+++ b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/event/ITmfEventField.java
@@ -1,11 +1,11 @@
 /*******************************************************************************
  * 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:
  *   Francois Chouinard - Initial API and implementation
  *******************************************************************************/
@@ -15,7 +15,7 @@ package org.eclipse.linuxtools.tmf.core.event;
 /**
  * The generic event payload in TMF. Each field can be either a terminal or
  * further decomposed into subfields.
- * 
+ *
  * @version 1.0
  * @author Francois Chouinard
  *
@@ -53,6 +53,7 @@ public interface ITmfEventField {
     public String[] getFieldNames();
 
     /**
+     * @param index The index of the field
      * @return the nth field name (null if absent or inexistent)
      */
     public String getFieldName(int index);
@@ -63,11 +64,13 @@ public interface ITmfEventField {
     public ITmfEventField[] getFields();
 
     /**
+     * @param name The name of the field
      * @return a specific subfield by name (null if absent or inexistent)
      */
     public ITmfEventField getField(String name);
 
     /**
+     * @param index The index of the field to return
      * @return a specific subfield by index (null if absent or inexistent)
      */
     public ITmfEventField getField(int index);