From acc9b347ded215b08ea09263812525efafd91b13 Mon Sep 17 00:00:00 2001
From: Earl Ou <shunhsingou@google.com>
Date: Fri, 7 Dec 2012 16:01:09 +0800
Subject: add javadoc for Rational and IfdId in Exif package

Change-Id: Ie67dde198337e6edae2e94d5c7e97b9b6063833e
---
 gallerycommon/src/com/android/gallery3d/exif/IfdId.java    |  5 ++++-
 gallerycommon/src/com/android/gallery3d/exif/Rational.java | 12 ++++++++++++
 2 files changed, 16 insertions(+), 1 deletion(-)

(limited to 'gallerycommon/src/com/android/gallery3d')

diff --git a/gallerycommon/src/com/android/gallery3d/exif/IfdId.java b/gallerycommon/src/com/android/gallery3d/exif/IfdId.java
index 1b9634369..c05fb02eb 100644
--- a/gallerycommon/src/com/android/gallery3d/exif/IfdId.java
+++ b/gallerycommon/src/com/android/gallery3d/exif/IfdId.java
@@ -15,12 +15,15 @@
  */
 package com.android.gallery3d.exif;
 
+/**
+ * The constants of the IFD ID defined in EXIF spec.
+ */
 public interface IfdId {
     public static final int TYPE_IFD_0 = 0;
     public static final int TYPE_IFD_1 = 1;
     public static final int TYPE_IFD_EXIF = 2;
     public static final int TYPE_IFD_INTEROPERABILITY = 3;
     public static final int TYPE_IFD_GPS = 4;
-    /* This is use in ExifData to allocate enough IfdData */
+    /* This is used in ExifData to allocate enough IfdData */
     static final int TYPE_IFD_COUNT = 5;
 }
diff --git a/gallerycommon/src/com/android/gallery3d/exif/Rational.java b/gallerycommon/src/com/android/gallery3d/exif/Rational.java
index 202c5d46d..3f8c18a88 100644
--- a/gallerycommon/src/com/android/gallery3d/exif/Rational.java
+++ b/gallerycommon/src/com/android/gallery3d/exif/Rational.java
@@ -16,6 +16,9 @@
 
 package com.android.gallery3d.exif;
 
+/**
+ * The rational data type of EXIF tag.
+ */
 public class Rational {
 
     private final long mNominator;
@@ -26,10 +29,16 @@ public class Rational {
         mDenominator = denominator;
     }
 
+    /*
+     * Gets the nominator of the rational.
+     */
     public long getNominator() {
         return mNominator;
     }
 
+    /*
+     * Gets the denominator of the rational
+     */
     public long getDenominator() {
         return mDenominator;
     }
@@ -48,6 +57,9 @@ public class Rational {
         return mNominator + "/" + mDenominator;
     }
 
+    /*
+     * Gets the rational value as type double.
+     */
     public double toDouble() {
         return mNominator / (double) mDenominator;
     }
-- 
cgit v1.2.3