From 65e375097ad1b3677a9dcd54ef2284ac1745b132 Mon Sep 17 00:00:00 2001
From: Tim Molter <tim.molter@gmail.com>
Date: Thu, 28 Mar 2013 12:42:26 +0100
Subject: [PATCH] java doc comments
---
.../main/java/com/xeiam/xchart/CSVImporter.java | 15 ++++++++++++---
1 file changed, 12 insertions(+), 3 deletions(-)
diff --git a/xchart/src/main/java/com/xeiam/xchart/CSVImporter.java b/xchart/src/main/java/com/xeiam/xchart/CSVImporter.java
index 594e5560..593fa80d 100644
--- a/xchart/src/main/java/com/xeiam/xchart/CSVImporter.java
+++ b/xchart/src/main/java/com/xeiam/xchart/CSVImporter.java
@@ -30,10 +30,19 @@ import java.util.ArrayList;
import java.util.List;
/**
+ * This class is used to create a Chart object from a folder containing one or more CSV files. The parent folder's name becomes the title of the chart. Each CSV file in the folder becomes a series on
+ * the chart. the CSV file's name becomes the series' name.
+ *
* @author timmolter
*/
public class CSVImporter {
+ /**
+ * @param path2Directory
+ * @param width
+ * @param height
+ * @return
+ */
public static Chart getChartFromCSVDir(String path2Directory, int width, int height) {
// 1. get the directory, name chart the dir name
@@ -95,8 +104,8 @@ public class CSVImporter {
/**
* This method returns the files found in the given directory matching the given regular expression.
*
- * @param dirName - ex. "./images/colors/original/" *make sure you have the '/' on the end
- * @param regex - ex. ".*.png"
+ * @param dirName - ex. "./path/to/directory/" *make sure you have the '/' on the end
+ * @param regex - ex. ".*.csv"
* @return File[] - an array of files
*/
public static File[] getAllFiles(String dirName, String regex) {
@@ -119,7 +128,7 @@ public class CSVImporter {
/**
* This method returns the Files found in the given directory
*
- * @param dirName - ex. "./images/colors/original/" *make sure you have the '/' on the end
+ * @param dirName - ex. "./path/to/directory/" *make sure you have the '/' on the end
* @return File[] - an array of files
*/
public static File[] getAllFiles(String dirName) {
--
GitLab