Fix javadoc warnings

[deliverable/tracecompass.git] / org.eclipse.linuxtools.tmf.ui / src / org / eclipse / linuxtools / tmf / ui / viewers / timeAnalysis / TmfTimeAnalysisProvider.java

diff --git a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/viewers/timeAnalysis/TmfTimeAnalysisProvider.java b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/viewers/timeAnalysis/TmfTimeAnalysisProvider.java
index 89ca2aa0a54274d19af11b60cd1641a9d8b7af47..944c8012ee0519fe908d94395b935e97bac69001 100644 (file)
--- a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/viewers/timeAnalysis/TmfTimeAnalysisProvider.java
+++ b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/viewers/timeAnalysis/TmfTimeAnalysisProvider.java
@@ -191,7 +191,7 @@ public abstract class TmfTimeAnalysisProvider {
         * convert it to an internal color index\r
         * \r
         * @param event\r
-        * @return\r
+        * @return the internal color index\r
         */\r
        public int getEventColorVal(ITimeEvent event) {\r
                StateColor colors = getEventColor(event);\r
@@ -234,7 +234,7 @@ public abstract class TmfTimeAnalysisProvider {
         * Select the color for the different internal variants of events.\r
         * \r
         * @param event\r
-        * @return\r
+        * @return the corresponding event color\r
         */\r
        public abstract StateColor getEventColor(ITimeEvent event);\r
 \r
@@ -244,7 +244,7 @@ public abstract class TmfTimeAnalysisProvider {
         * [java.lang.Thread]\r
         * \r
         * @param trace\r
-        * @return\r
+        * @return the trace class name\r
         */\r
        public abstract String getTraceClassName(ITmfTimeAnalysisEntry trace);\r
 \r
@@ -261,7 +261,7 @@ public abstract class TmfTimeAnalysisProvider {
         *            True return String value in Upper case\r
         * @param extInfo\r
         *            Verbose, add additional information if applicable\r
-        * @return\r
+        * @return the event name\r
         */\r
        public abstract String getEventName(ITimeEvent event, boolean upper,\r
                        boolean extInfo);\r
@@ -303,7 +303,7 @@ public abstract class TmfTimeAnalysisProvider {
         * different icons according to specific event /state combination\r
         * \r
         * @param obj\r
-        * @return\r
+        * @return the image icon\r
         */\r
        public Image getItemImage(Object obj) {\r
            /*\r