Version 0.1.1 (#1)

* Prepare version 0.1.1 branch

* Update README.md

* Add @return tags for javadocs

Author: Iker Ruiz de Infante Gonzalez

README.md

@@ -11,7 +11,7 @@ To use the ```wfc4j``` library in your Java project, you can include the library
 <dependency>
     <groupId>eu.irzinfante</groupId>
     <artifactId>wfc4j</artifactId>
-    <version>0.1.0</version>
+    <version>0.1.1</version>
 </dependency>
 ```
 
@@ -45,4 +45,4 @@ You should have received a copy of the GNU General Public License along with thi
 
 ## Acknowledgments
 
-The ```wfc4j``` library is inspired on Dan Shiffman's [Coding Challenge 171: Wave Function Collapse](https://youtu.be/rI_y2GAlQFM) video idea.
+The ```wfc4j``` library is inspired on Dan Shiffman's [Coding Challenge 171: Wave Function Collapse](https://youtu.be/rI_y2GAlQFM) video, which is based on the original [Wave Function Collapse Algorithm](https://github.com/mxgmn/WaveFunctionCollapse) developed by Maxim Gumin.

pom.xml

@@ -3,7 +3,7 @@
 	<modelVersion>4.0.0</modelVersion>
 	<groupId>eu.irzinfante</groupId>
 	<artifactId>wfc4j</artifactId>
-	<version>0.1.0</version>
+	<version>0.1.1</version>
 	<packaging>jar</packaging>
 
 	<properties>

src/main/java/eu/irzinfante/wfc4j/core/AbstractWaveFunctionCollapse1D.java

@@ -106,6 +106,7 @@ public void setCellConstraint(Cell1D<T> cell) throws DimensionException {
 	/**
 	 * Runs the WFC algorithm to populate the tile values for the cells of the grid
 	 * 
+	 * @return	A copy of the grid populated with tiles
 	 * @throws	TileException If exception occurs at the time of getting the adjacent tiles for some cell's value
 	 * 
 	 * @since	0.1.0
@@ -118,6 +119,7 @@ public Cell1D<T>[] generate() throws TileException {
 	 * Runs the WFC algorithm to populate the tile values for the cells of the grid until the specified recursion level
 	 * 
 	 * @param	maxDeepth Maximum level of recursion
+	 * @return	A copy of the grid populated with tiles
 	 * @throws	TileException If exception occurs at the time of getting the adjacent tiles for some cell's value
 	 * 
 	 * @since	0.1.0

src/main/java/eu/irzinfante/wfc4j/model/Cell1D.java

@@ -50,6 +50,7 @@ public Cell1D(Set<Tile<T>> entropy, int x) {
 	 * Returns the set intersection between the cell's current entropy and the intersectant set of tiles
 	 *
 	 * @param	intersectant The set of tiles to be intersected with the cell's current entropy
+	 * @return	The set intersection between the current cell entropy and the intersectant set
 	 * 
 	 * @since	0.1.0
 	 */

src/main/java/eu/irzinfante/wfc4j/model/TileMap1D.java

@@ -62,6 +62,7 @@ public TileMap1D(Set<Tile<T>> tileSet) throws TileException {
 	 *
 	 * @param	tile The given tile for which to get the possible adjacent tiles
 	 * @param	side The side of the given tile from which to get the possible adjacent tiles
+	 * @return	Set of tiles that can be adjacent to the provided tile from the selected side
 	 * @throws	TileException If the given tile is not in present in the tilemap's tileset
 	 * 
 	 * @since	0.1.0
@@ -102,6 +103,7 @@ public void setAdjacents(Tile<T> tile, Side1D side, Set<Tile<T>> adjacents) thro
 	 * @param	tile The given tile for which to add the possible adjacent tile
 	 * @param	side The side of the given tile for which to add the possible adjacent tile
 	 * @param	adjacent A single tile to be added to the possible adjacent tiles for the given tile
+	 * @return	true if the adjacent tile to be added was not already contained in the set of adjacent sets
 	 * @throws	TileException If the given tile or the potential adjacent tile to be added are not in present in the tilemap's tileset
 	 * 
 	 * @since	0.1.0