Javadoc fix and refactoring.

Author: brunomnsilva

src/main/java/com/brunomnsilva/smartgraph/example/City.java

@@ -28,6 +28,8 @@
 import com.brunomnsilva.smartgraph.graphview.SmartRadiusSource;
 import com.brunomnsilva.smartgraph.graphview.SmartShapeTypeSource;
 
+import java.util.Objects;
+
 /**
  * A simple class to represent a city in an example usage of the library.
  * @author brunomnsilva
@@ -37,7 +39,7 @@ public class City {
     private float population;
 
     /**
-     * City constructor
+     * Constructor for City instances.
      * @param name name of the city
      * @param population population (in millions)
      */
@@ -46,19 +48,35 @@ public City(String name, float population) {
         this.population = population;
     }
 
+    /**
+     * Returns the name of the city.
+     * @return the name of the city
+     */
     @SmartLabelSource
     public String getName() {
         return name;
     }
 
+    /**
+     * Setter for the name of the city.
+     * @param name the name of the city
+     */
     public void setName(String name) {
         this.name = name;
     }
 
+    /**
+     * Returns the population of the city.
+     * @return the population of the city
+     */
     public float getPopulation() {
         return population;
     }
 
+    /**
+     * Setter for the population of the city.
+     * @param population the population of the city
+     */
     public void setPopulation(float population) {
         this.population = population;
     }
@@ -67,19 +85,27 @@ public void setPopulation(float population) {
     public String toString() {
         return "City{" + "name=" + name + ", population=" + population + '}';
     }
-   
+
+    /**
+     * Establishes the shape of the vertex to use when representing this city.
+     * @return the name of the shape, see {@link com.brunomnsilva.smartgraph.graphview.ShapeFactory}
+     */
     @SmartShapeTypeSource
     public String modelShape() {
-        if(this.name == "Tokyo") {
+        if(Objects.equals(this.name, "Tokyo")) {
             return "star";
         }
 
         return "circle";
     }
 
+    /**
+     * Returns the radius of the vertex when representing this city.
+     * @return the radius of the vertex
+     */
     @SmartRadiusSource
     public Double modelRadius() {
-        return convertToLogScale(Double.valueOf(String.valueOf(this.population)));
+        return convertToLogScale(Double.parseDouble(String.valueOf(this.population)));
     }
 
     private static double convertToLogScale(double value) {

src/main/java/com/brunomnsilva/smartgraph/example/Distance.java

@@ -33,18 +33,34 @@
 public class Distance {
     private int distance;
 
+    /**
+     * Constructor for Distance instances.
+     * @param distance the distance
+     */
     public Distance(int distance) {
         this.distance = distance;
     }
 
+    /**
+     * Returns the distance.
+     * @return the distance
+     */
     public int getDistance() {
         return distance;
     }
 
+    /**
+     * Setter for the distance.
+     * @param distance the distance.
+     */
     public void setDistance(int distance) {
         this.distance = distance;
     }
-    
+
+    /**
+     * Establishes the text representation in the graph.
+     * @return the text representation of the distance
+     */
     @SmartLabelSource
     public String getDisplayDistance() {
         /* If the above annotation is not present, the toString()
@@ -58,8 +74,4 @@ public String toString() {
         return "Distance{" + "distance=" + distance + '}';
     }
 
-    
-
-    
-    
 }