summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorArghKevin <kagheli@student.sdccd.edu>2024-05-08 23:06:21 -0700
committerArghKevin <kagheli@student.sdccd.edu>2024-05-08 23:06:21 -0700
commitdad2361ea75d9198fbf17f8f274c05f00c378898 (patch)
treee88754bc6802ea9e629ae21595c3cbd6fbaf679e
parentf9268dd7e0e7a91e7a615bfffe18bceef31eae0d (diff)
Fix Javadoc comments.
-rw-r--r--src/CSVReader.java2
-rw-r--r--src/ComparisonView.java6
-rw-r--r--src/FontFamily.java8
-rw-r--r--src/JSONReader.java6
-rw-r--r--src/LineGraph.java4
-rw-r--r--src/Reader.java2
6 files changed, 15 insertions, 13 deletions
diff --git a/src/CSVReader.java b/src/CSVReader.java
index 3e1cd8f..1f3189a 100644
--- a/src/CSVReader.java
+++ b/src/CSVReader.java
@@ -28,7 +28,7 @@ public class CSVReader extends Reader {
parse();
}
- /*
+ /**
* Parse CSV file.
*/
public void parse() {
diff --git a/src/ComparisonView.java b/src/ComparisonView.java
index 1075abd..04961ce 100644
--- a/src/ComparisonView.java
+++ b/src/ComparisonView.java
@@ -22,7 +22,7 @@ public class ComparisonView extends JFrame {
private final int WINDOW_MIN_WIDTH = 960;
private final int WINDOW_MIN_HEIGHT = 540;
- /*
+ /**
* Walk the file tree.
*/
static void walk(File dir, ArrayList<File> list) {
@@ -39,7 +39,9 @@ public class ComparisonView extends JFrame {
}
}
- /* Initialize GUI and comparison. */
+ /**
+ * Initialize GUI and comparison.
+ */
public ComparisonView() {
setTitle("Google Fonts Style vs. Popularity"); // Window title
setMinimumSize(new Dimension(WINDOW_MIN_WIDTH,
diff --git a/src/FontFamily.java b/src/FontFamily.java
index 8e32f05..39fae26 100644
--- a/src/FontFamily.java
+++ b/src/FontFamily.java
@@ -34,7 +34,7 @@ public class FontFamily {
/* popularity.json and families.csv are shared among all families.
Have their associated objects passed from outside. */
- /*
+ /**
* Constructor.
*/
public FontFamily(JSONReader metadata, JSONReader popularity, CSVReader styles) {
@@ -44,7 +44,7 @@ public class FontFamily {
parseStyles(styles);
}
- /*
+ /**
* Parse metadata.
*/
private void parseMetadata(JSONReader metadata) {
@@ -56,13 +56,13 @@ public class FontFamily {
category = metadata.get("category");
}
- /*
+ /**
* Parse popularity.
*/
private void parsePopularity(JSONReader popularity) {
}
- /*
+ /**
* Parse styles.
*/
private void parseStyles(CSVReader styles) {
diff --git a/src/JSONReader.java b/src/JSONReader.java
index 786b2a1..8d670b6 100644
--- a/src/JSONReader.java
+++ b/src/JSONReader.java
@@ -19,7 +19,7 @@ public class JSONReader extends Reader {
super(file);
}
- /*
+ /**
* Search for and return the first
* match.
*/
@@ -27,14 +27,14 @@ public class JSONReader extends Reader {
return null;
}
- /*
+ /**
* Search for and return all matches.
*/
public String[] getAll(String field) {
return null;
}
- /*
+ /**
* Search for and return a table of fields.
*/
public String getTable(HashMap<String,String> name) {
diff --git a/src/LineGraph.java b/src/LineGraph.java
index b698462..4e05bb7 100644
--- a/src/LineGraph.java
+++ b/src/LineGraph.java
@@ -16,7 +16,7 @@ import javax.swing.*;
public class LineGraph {
int[][] coordinates; // A line graph has-a set of coordinates
- /*
+ /**
* Constructor.
*/
public LineGraph() {
@@ -24,7 +24,7 @@ public class LineGraph {
}
- /*
+ /**
* Set a point at a pair of coordinates.
*/
void setCoordinates(int y, int x) {
diff --git a/src/Reader.java b/src/Reader.java
index 8c3caf8..024088e 100644
--- a/src/Reader.java
+++ b/src/Reader.java
@@ -42,7 +42,7 @@ class Reader {
}
}
- /*
+ /**
* @return the contents of the file.
*/
String getContents() {