From e1feb4e5b772dfcb65b26fcbf9f9277a03c4ec0e Mon Sep 17 00:00:00 2001
From: Hannes Janetzek <hannes.janetzek@gmail.com>
Date: Wed, 2 Apr 2014 17:59:48 +0200
Subject: [PATCH] docs: ITileDataSink

---
 vtm/src/org/oscim/tiling/ITileDataSink.java | 18 +++++++++++++-----
 1 file changed, 13 insertions(+), 5 deletions(-)

diff --git a/vtm/src/org/oscim/tiling/ITileDataSink.java b/vtm/src/org/oscim/tiling/ITileDataSink.java
index 3bfbec5a..dac9e2b0 100644
--- a/vtm/src/org/oscim/tiling/ITileDataSink.java
+++ b/vtm/src/org/oscim/tiling/ITileDataSink.java
@@ -20,17 +20,25 @@ import org.oscim.backend.canvas.Bitmap;
 import org.oscim.core.MapElement;
 
 /**
- * MapDatabase callback (implemented by MapTileLoader)
- * .
- * NOTE: MapElement passed belong to the caller! i.e. dont hold
- * references to any of its data after callback function returns.
+ * ITileDataSink callbacks (implemented by MapTileLoader)
  */
 public interface ITileDataSink {
-
+	/**
+	 * Pass read MapElement data to loader.
+	 * <p>
+	 * NOTE: MapElement passed belong to the caller! i.e. dont hold references
+	 * to any of its data after callback function returns.
+	 */
 	void process(MapElement element);
 
+	/**
+	 * Pass read Bitmap data to loader.
+	 */
 	void setTileImage(Bitmap bitmap);
 
+	/**
+	 * Notify loader that tile loading is completed.
+	 */
 	void completed(QueryResult result);
 
 	public static enum QueryResult {