android: add some comments to TileProvider interface

Change-Id: I1c6f7bccda2392235242f5c26af1437f1365f728

1 files changed, 30 insertions, 0 deletions

diff --git a/android/experimental/LOAndroid3/src/java/org/libreoffice/TileProvider.java b/android/experimental/LOAndroid3/src/java/org/libreoffice/TileProvider.java
index da0d0f40d8b2..ed9682f39af1 100644
--- a/android/experimental/LOAndroid3/src/java/org/libreoffice/TileProvider.java
+++ b/android/experimental/LOAndroid3/src/java/org/libreoffice/TileProvider.java
@@ -9,8 +9,14 @@ import org.mozilla.gecko.gfx.CairoImage;
 import org.mozilla.gecko.gfx.IntSize;
 
 public interface TileProvider {
+    /**
+     * Returns the page width in pixels.
+     */
     int getPageWidth();
 
+    /**
+     * Returns the page height in pixels.
+     */
     int getPageHeight();
 
     boolean isReady();
@@ -22,18 +28,42 @@ public interface TileProvider {
      */
     void rerenderTile(CairoImage image, float x, float y, IntSize tileSize, float zoom);
 
+    /**
+     * Change the document part to the one specified by the partIndex input parameter.
+     * @param partIndex - part index to change to
+     */
     void changePart(int partIndex);
 
+    /**
+     * Get the current document part number.
+     * @return
+     */
     int getCurrentPartNumber();
 
     Bitmap thumbnail(int size);
 
+    /**
+     * Closes the document.
+     */
     void close();
 
+    /**
+     * Returns true if the current open document is a text document.
+     */
     boolean isTextDocument();
 
+    /**
+     * Register a callback that is invoked when a tile invalidation is
+     * required.
+     *
+     * @param tileInvalidationCallback - the tile invalidation callback
+     */
     void registerInvalidationCallback(TileProvider.TileInvalidationCallback tileInvalidationCallback);
 
+    /**
+     * Trigger a key press.
+     * @param keyEvent - contains the
+     */
     void keyPress(KeyEvent keyEvent);
 
     /**