Author: sebb
Date: Tue Apr  8 17:08:02 2008
New Revision: 646150

URL: http://svn.apache.org/viewvc?rev=646150&view=rev
Log:
Javadoc errors

Modified:
    jakarta/jmeter/trunk/src/reports/org/apache/jmeter/report/ReportChart.java
    
jakarta/jmeter/trunk/src/reports/org/apache/jmeter/report/writers/AbstractReportWriter.java
    
jakarta/jmeter/trunk/src/reports/org/apache/jmeter/report/writers/ReportSummary.java
    
jakarta/jmeter/trunk/src/reports/org/apache/jmeter/testelement/AbstractChart.java
    jakarta/jmeter/trunk/src/reports/org/apache/jmeter/testelement/BarChart.java
    jakarta/jmeter/trunk/src/reports/org/apache/jmeter/testelement/JTLData.java
    
jakarta/jmeter/trunk/src/reports/org/apache/jmeter/testelement/LineChart.java

Modified: 
jakarta/jmeter/trunk/src/reports/org/apache/jmeter/report/ReportChart.java
URL: 
http://svn.apache.org/viewvc/jakarta/jmeter/trunk/src/reports/org/apache/jmeter/report/ReportChart.java?rev=646150&r1=646149&r2=646150&view=diff
==============================================================================
--- jakarta/jmeter/trunk/src/reports/org/apache/jmeter/report/ReportChart.java 
(original)
+++ jakarta/jmeter/trunk/src/reports/org/apache/jmeter/report/ReportChart.java 
Tue Apr  8 17:08:02 2008
@@ -1,4 +1,3 @@
-//$Header$
 /*
  * Licensed to the Apache Software Foundation (ASF) under one or more
  * contributor license agreements.  See the NOTICE file distributed with
@@ -27,7 +26,7 @@
      * The method takes a list of the DataSet items. It is up to the chart
      * class to extract the data and use it to render a graphic.
      * @param list of DataSet 
-     * @return
+     * @return the component
      */
        JComponent renderChart(List data);
 }

Modified: 
jakarta/jmeter/trunk/src/reports/org/apache/jmeter/report/writers/AbstractReportWriter.java
URL: 
http://svn.apache.org/viewvc/jakarta/jmeter/trunk/src/reports/org/apache/jmeter/report/writers/AbstractReportWriter.java?rev=646150&r1=646149&r2=646150&view=diff
==============================================================================
--- 
jakarta/jmeter/trunk/src/reports/org/apache/jmeter/report/writers/AbstractReportWriter.java
 (original)
+++ 
jakarta/jmeter/trunk/src/reports/org/apache/jmeter/report/writers/AbstractReportWriter.java
 Tue Apr  8 17:08:02 2008
@@ -1,4 +1,3 @@
-//$Header$
 /*
  * Licensed to the Apache Software Foundation (ASF) under one or more
  * contributor license agreements.  See the NOTICE file distributed with
@@ -84,7 +83,7 @@
        
     /**
      * return the day in YYYYMMDD format
-     * @return
+     * @return the date
      */
        public String getDayString() {
                Calendar today = Calendar.getInstance();

Modified: 
jakarta/jmeter/trunk/src/reports/org/apache/jmeter/report/writers/ReportSummary.java
URL: 
http://svn.apache.org/viewvc/jakarta/jmeter/trunk/src/reports/org/apache/jmeter/report/writers/ReportSummary.java?rev=646150&r1=646149&r2=646150&view=diff
==============================================================================
--- 
jakarta/jmeter/trunk/src/reports/org/apache/jmeter/report/writers/ReportSummary.java
 (original)
+++ 
jakarta/jmeter/trunk/src/reports/org/apache/jmeter/report/writers/ReportSummary.java
 Tue Apr  8 17:08:02 2008
@@ -1,4 +1,3 @@
-//$Header$
 /*
  * Licensed to the Apache Software Foundation (ASF) under one or more
  * contributor license agreements.  See the NOTICE file distributed with
@@ -19,7 +18,6 @@
 package org.apache.jmeter.report.writers;
 
 /**
- * @author Peter Lin
  *
  * The purpose of ReportSummary is to provide a detailed description of the
  * reports generated, how long it took and where the generated files are
@@ -35,13 +33,13 @@
      * This should be the elapsed time to run all the reports. Classes
      * implementing it should simply add up the elapsed time for each
      * report page.
-     * @return
+     * @return elapsed time
      */
     long getElapsedTime();
     /**
      * The method should return a list of the pages generated for the
      * report and whether it succeeded or not
-     * @return
+     * @return page summary array
      */
     PageSummary[] getPagesSummaries();
     /**

Modified: 
jakarta/jmeter/trunk/src/reports/org/apache/jmeter/testelement/AbstractChart.java
URL: 
http://svn.apache.org/viewvc/jakarta/jmeter/trunk/src/reports/org/apache/jmeter/testelement/AbstractChart.java?rev=646150&r1=646149&r2=646150&view=diff
==============================================================================
--- 
jakarta/jmeter/trunk/src/reports/org/apache/jmeter/testelement/AbstractChart.java
 (original)
+++ 
jakarta/jmeter/trunk/src/reports/org/apache/jmeter/testelement/AbstractChart.java
 Tue Apr  8 17:08:02 2008
@@ -1,4 +1,3 @@
-//$Header$
 /*
  * Licensed to the Apache Software Foundation (ASF) under one or more
  * contributor license agreements.  See the NOTICE file distributed with
@@ -31,8 +30,7 @@
  * The general idea of the chart graphs information for a table.
  * A chart can only be generated from a specific table, though more
  * than one chart can be generated from a single table.
- * @author Peter Lin
- *
+  *
  */
 public abstract class AbstractChart extends AbstractTestElement implements 
ReportChart {
 
@@ -106,7 +104,7 @@
      * The title is a the name for the chart. A page link will
      * be generated using the title. The title will also be
      * used for a page index.
-     * @return
+     * @return chart title
      */
     public String getTitle() {
        return getPropertyAsString(REPORT_CHART_TITLE);
@@ -125,7 +123,7 @@
     /**
      * The caption is a description for the chart explaining
      * what the chart means.
-     * @return
+     * @return caption
      */
     public String getCaption() {
         return getPropertyAsString(REPORT_CHART_CAPTION);
@@ -142,7 +140,7 @@
     
     /**
      * if no width is set, the default is returned
-     * @return
+     * @return width
      */
     public int getWidth() {
         int w = getPropertyAsInt(REPORT_CHART_WIDTH);
@@ -163,7 +161,7 @@
     
     /**
      * if the height is not set, the default is returned
-     * @return
+     * @return height
      */
     public int getHeight() {
         int h = getPropertyAsInt(REPORT_CHART_HEIGHT); 
@@ -193,7 +191,7 @@
     
     /**
      * this makes it easy to get the bufferedImage
-     * @return
+     * @return image
      */
     public BufferedImage getBufferedImage() {
         return this.image;
@@ -212,7 +210,7 @@
      * Method.invoke(Object,Object[]), it's simpler to just check which
      * column is selected and call the method directly.
      * @param stat
-     * @return
+     * @return value
      */
     public double getValue(SamplingStatCalculator stat) {
         if (this.getXAxis().equals(AbstractTable.REPORT_TABLE_50_PERCENT)) {

Modified: 
jakarta/jmeter/trunk/src/reports/org/apache/jmeter/testelement/BarChart.java
URL: 
http://svn.apache.org/viewvc/jakarta/jmeter/trunk/src/reports/org/apache/jmeter/testelement/BarChart.java?rev=646150&r1=646149&r2=646150&view=diff
==============================================================================
--- 
jakarta/jmeter/trunk/src/reports/org/apache/jmeter/testelement/BarChart.java 
(original)
+++ 
jakarta/jmeter/trunk/src/reports/org/apache/jmeter/testelement/BarChart.java 
Tue Apr  8 17:08:02 2008
@@ -31,7 +31,6 @@
 
 /**
  * The class is reponsible for returning 
- * @author pete
  *
  */
 public class BarChart extends AbstractChart {
@@ -53,7 +52,7 @@
     /**
      * Convert the data from SamplingStatCalculator to double array of array
      * @param data
-     * @return
+     * @return data values
      */
     public double[][] convertToDouble(List data) {
         double[][] dataset = new double[1][data.size()];

Modified: 
jakarta/jmeter/trunk/src/reports/org/apache/jmeter/testelement/JTLData.java
URL: 
http://svn.apache.org/viewvc/jakarta/jmeter/trunk/src/reports/org/apache/jmeter/testelement/JTLData.java?rev=646150&r1=646149&r2=646150&view=diff
==============================================================================
--- jakarta/jmeter/trunk/src/reports/org/apache/jmeter/testelement/JTLData.java 
(original)
+++ jakarta/jmeter/trunk/src/reports/org/apache/jmeter/testelement/JTLData.java 
Tue Apr  8 17:08:02 2008
@@ -33,7 +33,6 @@
 import org.apache.jmeter.visualizers.SamplingStatCalculator;
 
 /**
- * @author Peter Lin
  *
  * The purpose of TableData is to contain the results of a single .jtl file.
  * It is equivalent to what the AggregateListener table. A HashMap is used
@@ -55,8 +54,8 @@
        }
 
     /**
-     * Return a Set of the URL's
-     * @return
+     * Return a Set of the URLs
+     * @return set of URLs
      */
     public Set getURLs() {
         return this.data.keySet();
@@ -64,7 +63,7 @@
     
     /**
      * Return a Set of the values
-     * @return
+     * @return values
      */
     public Set getStats() {
         return this.data.entrySet();
@@ -72,12 +71,12 @@
     
     /**
      * The purpose of the method is to make it convienant to pass a list
-     * of the URL's and return a list of the SamplingStatCalculators. If
-     * no URL's match, the list is empty.
+     * of the URLs and return a list of the SamplingStatCalculators. If
+     * no URLs match, the list is empty.
      * The SamplingStatCalculators will be returned in the same sequence
      * as the url list.
      * @param urls
-     * @return
+     * @return array list of non-null entries (may be empty)
      */
     public List getStats(List urls) {
         ArrayList items = new ArrayList();
@@ -127,7 +126,7 @@
      * reasoning is that a test may run for a long time, but it
      * is most likely scheduled to run using CRON on unix or
      * scheduled task in windows.
-     * @return
+     * @return start time
      */
     public Date getDate() {
         return new Date(this.startTimestamp);
@@ -152,7 +151,7 @@
      * The method will SamplingStatCalculator for the given URL. If the URL
      * doesn't exist, the method returns null.
      * @param url
-     * @return
+     * @return data for this URL
      */
     public SamplingStatCalculator getStatistics(String url) {
         if (this.data.containsKey(url)) {

Modified: 
jakarta/jmeter/trunk/src/reports/org/apache/jmeter/testelement/LineChart.java
URL: 
http://svn.apache.org/viewvc/jakarta/jmeter/trunk/src/reports/org/apache/jmeter/testelement/LineChart.java?rev=646150&r1=646149&r2=646150&view=diff
==============================================================================
--- 
jakarta/jmeter/trunk/src/reports/org/apache/jmeter/testelement/LineChart.java 
(original)
+++ 
jakarta/jmeter/trunk/src/reports/org/apache/jmeter/testelement/LineChart.java 
Tue Apr  8 17:08:02 2008
@@ -115,7 +115,7 @@
      * Since we only have 4 shapes, the method will start with the
      * first shape and keep cycling through the shapes in order.
      * @param count
-     * @return
+     * @return array of shapes
      */
     public Shape[] createShapes(int count) {
         Shape[] shapes = new Shape[count];
@@ -127,7 +127,7 @@
     
     /**
      * Return the next shape
-     * @return
+     * @return the shape
      */
     public Shape nextShape() {
         if (shape_counter >= (SHAPE_ARRAY.length - 1)) {
@@ -139,7 +139,7 @@
     /**
      * 
      * @param count
-     * @return
+     * @return array of strokes
      */
     public Stroke[] createStrokes(int count) {
         Stroke[] str = new Stroke[count];



---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]

Reply via email to