Remove extraneous @return tag

Author: hybras

src/main/java/com/thebluealliance/api/v3/models/Award.java

@@ -19,35 +19,35 @@ public class Award {
 	String event_key;
 
 	/**
-	 * @return Integer representing the type of award given.
+	 * Integer representing the type of award given.
+	 * 
 	 * @see <a href="https://github.com/the-blue-alliance/the-blue-alliance/blob/master/consts/award_type.py#L6">award_type.py</a>
 	 */
 	int award_type;
 
 	/**
-	 * @return The year this award was won.
+	 * The year this award was won.
 	 */
 	int year;
 
 	/**
-	 * @return A list of recipients of the award at the event.
+	 * A list of recipients of the award at the event.
 	 */
 	AwardRecipient[] recipient_list;
 
-
 	/**
 	 * An <code>AwardRecipient</code> object represents the team and/or person who received an award at an event.
 	 */
 	@Value
 	public class AwardRecipient {
 
 		/**
-		 * @return The TBA team key for the team that was given the award. May be <code>null</code>.
+		 * The TBA team key for the team that was given the award. May be <code>null</code>.
 		 */
 		String team_key;
 
 		/**
-		 * @return The name of the individual given the award. May be <code>null</code>.
+		 * The name of the individual given the award. May be <code>null</code>.
 		 */
 		String awardee;
 	}

src/main/java/com/thebluealliance/api/v3/models/District.java

@@ -9,22 +9,22 @@
 public class District {
 
 	/**
-	 * @return The short identifier for the district.
+	 * The short identifier for the district.
 	 */
 	String abbreviation;
 
 	/**
-	 * @return The long name for the district.
+	 * The long name for the district.
 	 */
 	String display_name;
 
 	/**
-	 * @return Key for this district, e.g. <code>2016ne</code>.
+	 * Key for this district, e.g. <code>2016ne</code>.
 	 */
 	String key;
 
 	/**
-	 * @return Year this district participated.
+	 * Year this district participated.
 	 */
 	int year;
 }

src/main/java/com/thebluealliance/api/v3/models/DistrictRanking.java

@@ -9,27 +9,27 @@
 public class DistrictRanking {
 
 	/**
-	 * @return TBA team key for the team.
+	 * TBA team key for the team.
 	 */
 	String team_key;
 
 	/**
-	 * @return Numerical rank of the team, 1 being top rank.
+	 * Numerical rank of the team, 1 being top rank.
 	 */
 	int rank;
 
 	/**
-	 * @return Any points added to a team as a result of the rookie bonus.
+	 * Any points added to a team as a result of the rookie bonus.
 	 */
 	int rookie_bonus;
 
 	/**
-	 * @return Total district points for the team.
+	 * Total district points for the team.
 	 */
 	int point_total;
 
 	/**
-	 * @return List of events and their associated points that contributed to the point total for the team.
+	 * List of events and their associated points that contributed to the point total for the team.
 	 */
 	EventPoints[] event_points;
 

src/main/java/com/thebluealliance/api/v3/models/EliminationAlliance.java

@@ -9,27 +9,27 @@
 public class EliminationAlliance {
 
 	/**
-	 * @return Alliance name, may be null.
+	 * Alliance name, may be null.
 	 */
 	String name;
 
 	/**
-	 * @return Backup team called in, may be null.
+	 * Backup team called in, may be null.
 	 */
 	AllianceBackup backup;
 
 	/**
-	 * @return List of team keys that declined the alliance.
+	 * List of team keys that declined the alliance.
 	 */
 	String[] declines;
 
 	/**
-	 * @return List of team keys picked for the alliance. First pick is captain.
+	 * List of team keys picked for the alliance. First pick is captain.
 	 */
 	String[] picks;
 
 	/**
-	 * @return A {@link PlayoffStatus} object with current statistics of the alliance.
+	 * A {@link PlayoffStatus} object with current statistics of the alliance.
 	 */
 	PlayoffStatus status;
 
@@ -40,12 +40,12 @@ public class EliminationAlliance {
 	public class AllianceBackup {
 
 		/**
-		 * @return Team key that was replaced by the backup team.
+		 * Team key that was replaced by the backup team.
 		 */
 		String out;
 
 		/**
-		 * @return Team key that was called in as the backup.
+		 * Team key that was called in as the backup.
 		 */
 		String in;
 
@@ -58,27 +58,27 @@ public class AllianceBackup {
 	public class PlayoffStatus {
 
 		/**
-		 * @return The level of the bracket that an alliance is currently in or was eliminated in. Value may be <code>qf</code>, <code>sf</code>, or <code>f</code>
+		 * The level of the bracket that an alliance is currently in or was eliminated in. Value may be <code>qf</code>, <code>sf</code>, or <code>f</code>
 		 */
 		String level;
 
 		/**
-		 * @return The current playing status of an alliance. Value may be <code>eliminated</code>, <code>won</code>, or <code>playing</code>.
+		 * The current playing status of an alliance. Value may be <code>eliminated</code>, <code>won</code>, or <code>playing</code>.
 		 */
 		String status;
 
 		/**
-		 * @return A {@link WLTRecord} for the alliance at the current level of the playoff tournament
+		 * A {@link WLTRecord} for the alliance at the current level of the playoff tournament
 		 */
 		WLTRecord current_level_record;
 
 		/**
-		 * @return A {@link WLTRecord} for the alliance during the entire playoff tournament
+		 * A {@link WLTRecord} for the alliance during the entire playoff tournament
 		 */
 		WLTRecord record;
 
 		/**
-		 * @return The average of all playoff matches of an alliance. May be <code>null</code>.
+		 * The average of all playoff matches of an alliance. May be <code>null</code>.
 		 */
 		double playoff_average;
 

src/main/java/com/thebluealliance/api/v3/models/Event.java

@@ -9,122 +9,122 @@
 public class Event {
 
 	/**
-	 * @return A list of webcasts for the event
+	 * A list of webcasts for the event
 	 */
 	Webcast[] webcasts;
 
 	/**
-	 * @return Postal code from the event address.
+	 * Postal code from the event address.
 	 */
 	String postal_code;
 	/**
-	 * @return The TBA Event key that represents the event's parent. Used to link back to the event from a division event. It is also the inverse relation of <code>divison_keys</code>.
+	 * The TBA Event key that represents the event's parent. Used to link back to the event from a division event. It is also the inverse relation of <code>divison_keys</code>.
 	 */
 	String parent_event_key;
 	/**
-	 * @return Same as <code>name</code> but doesn�t include event specifiers, such as �Regional� or 'District�. May be null.
+	 * Same as <code>name</code> but doesn�t include event specifiers, such as �Regional� or 'District�. May be null.
 	 */
 	String short_name;
 	/**
-	 * @return Link to address location on Google Maps.
+	 * Link to address location on Google Maps.
 	 */
 	String gmaps_url;
 	/**
-	 * @return String representation of the <code>playoff_type</code>, or null.
+	 * String representation of the <code>playoff_type</code>, or null.
 	 */
 	String playoff_type_string;
 	/**
-	 * @return Event Type, eg Regional, District, or Offseason.
+	 * Event Type, eg Regional, District, or Offseason.
 	 */
 	String event_type_string;
 	/**
-	 * @return Google Maps Place ID for the event address.
+	 * Google Maps Place ID for the event address.
 	 */
 	String gmaps_place_id;
 	/**
-	 * @return Address of the event�s venue, if available
+	 * Address of the event�s venue, if available
 	 */
 	String address;
 	/**
-	 * @return Name of the location at the address for the event, eg. Blue Alliance High School.
+	 * Name of the location at the address for the event, eg. Blue Alliance High School.
 	 */
 	String location_name;
 	/**
-	 * @return Timezone name.
+	 * Timezone name.
 	 */
 	String timezone;
 	/**
-	 * @return The FIRST internal Event ID, used to link to the event on the FRC webpage.
+	 * The FIRST internal Event ID, used to link to the event on the FRC webpage.
 	 */
 	String first_event_id;
 	/**
-	 * @return The event's website, if any.
+	 * The event's website, if any.
 	 */
 	String website;
 
 	/**
-	 * @return Latitude for the event address.
+	 * Latitude for the event address.
 	 */
 	double lat;
 	/**
-	 * @return Longitude for the event address.
+	 * Longitude for the event address.
 	 */
 	double lng;
 	/**
-	 * @return An array of event keys for the divisions at this event.
+	 * An array of event keys for the divisions at this event.
 	 */
 	String[] division_keys;
 	/**
-	 * @return Week of the competition season this event is in.
+	 * Week of the competition season this event is in.
 	 */
 	int week;
 	/**
-	 * @return Year the event data is for.
+	 * Year the event data is for.
 	 */
 	int year;
 	/**
-	 * @return Playoff Type, as defined <a href="https://github.com/the-blue-alliance/the-blue-alliance/blob/master/consts/playoff_type.py#L4">here</a> , or null.
+	 * Playoff Type, as defined <a href="https://github.com/the-blue-alliance/the-blue-alliance/blob/master/consts/playoff_type.py#L4">here</a> , or null.
 	 */
 	int playoff_type;
 	/**
-	 * @return Event Type, as defined <a href="https://github.com/the-blue-alliance/the-blue-alliance/blob/master/consts/event_type.py#L2">here</a>
+	 * Event Type, as defined <a href="https://github.com/the-blue-alliance/the-blue-alliance/blob/master/consts/event_type.py#L2">here</a>
 	 */
 	int event_type;
 
 	/**
-	 * @return City, town, village, etc. the event is located in.
+	 * City, town, village, etc. the event is located in.
 	 */
 	String city;
 	/**
-	 * @return Event start date in <code>yyyy-mm-dd</code> format.
+	 * Event start date in <code>yyyy-mm-dd</code> format.
 	 */
 	String start_date;
 	/**
-	 * @return Official name of event on record either provided by FIRST or organizers of offseason event.
+	 * Official name of event on record either provided by FIRST or organizers of offseason event.
 	 */
 	String name;
 	/**
-	 * @return Event short code, as provided by FIRST.
+	 * Event short code, as provided by FIRST.
 	 */
 	String event_code;
 	/**
-	 * @return Event end date in <code>yyyy-mm-dd</code> format.
+	 * Event end date in <code>yyyy-mm-dd</code> format.
 	 */
 	String end_date;
 	/**
-	 * @return Country the event is located in.
+	 * Country the event is located in.
 	 */
 	String country;
 	/**
-	 * @return State or Province the event is located in.
+	 * State or Province the event is located in.
 	 */
 	String state_prov;
 	/**
-	 * @return TBA event key with the format yyyy[EVENT_CODE], where yyyy is the year, and EVENT_CODE is the event code of the event.
+	 * TBA event key with the format yyyy[EVENT_CODE], where yyyy is the year, and EVENT_CODE is the event code of the event.
 	 */
 	String key;
 	/**
-	 * @return A {@link District} object representing the district the event is in. May be null.
+	 * A {@link District} object representing the district the event is in. May be null.
 	 */
 	District district;
 
@@ -135,16 +135,16 @@ public class Event {
 	public class Webcast {
 
 		/**
-		 * @return Type of webcast, typically descriptive of the streaming provider. Value may be <code>youtube</code>, <code>twitch</code>, <code>ustream</code>, <code>iframe</code>, <code>html5</code>,
-		 *         <code>rtmp</code>, or <code>livestream</code>
+		 * Type of webcast, typically descriptive of the streaming provider. Value may be <code>youtube</code>, <code>twitch</code>, <code>ustream</code>, <code>iframe</code>, <code>html5</code>,
+		 * <code>rtmp</code>, or <code>livestream</code>
 		 */
 		String type;
 		/**
-		 * @return Type specific channel information. May be the YouTube stream, or Twitch channel name. In the case of iframe types, contains HTML to embed the stream in an HTML iframe.
+		 * Type specific channel information. May be the YouTube stream, or Twitch channel name. In the case of iframe types, contains HTML to embed the stream in an HTML iframe.
 		 */
 		String channel;
 		/**
-		 * @return File identification as may be required for some types. May be null.
+		 * File identification as may be required for some types. May be null.
 		 */
 		String file;
 

src/main/java/com/thebluealliance/api/v3/models/EventDistrictPoints.java

@@ -13,15 +13,17 @@ public class EventDistrictPoints {
 	private HashMap<String, Tiebreaker> tiebreakers;
 
 	/**
-	 * @param teamNumber Team number used for a query
+	 * @param teamNumber
+	 *                       Team number used for a query
 	 * @return A {@link Tiebreaker} object for that team
 	 */
 	public Tiebreaker getTiebreaker(int teamNumber) {
 		return tiebreakers.get("frc" + teamNumber);
 	}
 
 	/**
-	 * @param teamNumber Team number used for a query
+	 * @param teamNumber
+	 *                       Team number used for a query
 	 * @return The {@link EventPoints} the team earned
 	 */
 	public EventPoints getEventPoints(int teamNumber) {
@@ -34,11 +36,11 @@ public EventPoints getEventPoints(int teamNumber) {
 	@Value
 	public class Tiebreaker {
 		/**
-		 * @return Number of qualification match wins
+		 * Number of qualification match wins
 		 */
 		private int qual_wins;
 		/**
-		 * @return List of three highest qualification match scores
+		 * List of three highest qualification match scores
 		 */
 		private int[] highest_qual_scores;
 	}