Finished Commenting the code

Author: PickledMonkey

src/GameBoard.cpp

@@ -307,8 +307,6 @@ int GameBoard::FindLongestRoad(Player & owner){
 		Coordinate start = roadVector->first;
 		int temp_longest_path = FindLongestRoad_FromPoint(start, owner, marked, 0);
 
-		std::cout << "LONGEST PATH: " << start.first << ", " << start.second << ": " << temp_longest_path << "\n";
-
 		//if that path is longer than the current longest, set to the longest
 		if (temp_longest_path > longest_path)
 			longest_path = temp_longest_path;
@@ -319,9 +317,6 @@ int GameBoard::FindLongestRoad(Player & owner){
 
 
 int GameBoard::FindLongestRoad_FromPoint(Coordinate curr, Player & owner, std::map<Coordinate, bool>& marked, int length){
-
-	std::cout << "       " << curr.first << ", " << curr.second << ": " << length << "\n";
-
 	marked[curr] = true;
 	int longest_path = length;
 	//traverse all the surrounding edges and vertices

src/Road.cpp

@@ -35,35 +35,55 @@ Road::~Road() {
 
 }
 
+/**
+ * Returns the starting coordinate of the road
+ */
 Coordinate Road::getStart() const{
 	return start;
 }
+
+/**
+ * Returns the ending coordinate of the road
+ */
 Coordinate Road::getEnd() const{
 	return end;
 }
 
+/**
+ * Returns true if the roads have the same coordinates whether they are matching starting or ending coordinates doesn't matter
+ */
 bool Road::equals(const Road& otherRoad){
 	Coordinate otherstart = otherRoad.getStart();
 	Coordinate otherend = otherRoad.getEnd();
 	return equals(otherstart, otherend);
 }
 
+/**
+ * Returns true if the roads have the same coordinates whether they are matching starting or ending coordinates doesn't matter
+ */
 bool Road::equals(const Coordinate& otherStart, const Coordinate& otherEnd){
 	if((otherStart == start && otherEnd == end) || (otherStart == end && otherEnd == start))
 		return true;
 	return false;
 }
 
-
-
+/**
+ * Returns true if the road is marked, false otherwise
+ */
 bool Road::isMarked(){
 	return marker;
 }
 
+/**
+ * Marks the road
+ */
 void Road::mark(){
 	marker = true;
 }
 
+/**
+ * Unmarks the road
+ */
 void Road::unmark(){
 	marker = false;
 }