svn commit: r1595369 - /hbase/trunk/hbase-server/src/main/java/org/apache/hadoop/hbase/io/hfile/package-info.java

[st...@apache.org]

Author: stack
Date: Fri May 16 22:22:28 2014
New Revision: 1595369

URL: http://svn.apache.org/r1595369
Log:
HBASE-11171 More doc improvements on block cache options -- ADDENDUM TO FIX JAVADOC WARNINGS

Modified:
    hbase/trunk/hbase-server/src/main/java/org/apache/hadoop/hbase/io/hfile/package-info.java

Modified: hbase/trunk/hbase-server/src/main/java/org/apache/hadoop/hbase/io/hfile/package-info.java
URL: http://svn.apache.org/viewvc/hbase/trunk/hbase-server/src/main/java/org/apache/hadoop/hbase/io/hfile/package-info.java?rev=1595369&r1=1595368&r2=1595369&view=diff
==============================================================================
--- hbase/trunk/hbase-server/src/main/java/org/apache/hadoop/hbase/io/hfile/package-info.java (original)
+++ hbase/trunk/hbase-server/src/main/java/org/apache/hadoop/hbase/io/hfile/package-info.java Fri May 16 22:22:28 2014
@@ -53,7 +53,8 @@
  * <a href="http://blog.cloudera.com/blog/2012/01/caching-in-hbase-slabcache/">Caching
  * in Apache HBase: SlabCache</a>.To enable it,
  * set the float <code>hbase.offheapcache.percentage</code>
- * ({@link CacheConfig#SLAB_CACHE_OFFHEAP_PERCENTAGE_KEY}) to some value between 0 and 1 in
+ * ({@link org.apache.hadoop.hbase.io.hfile.CacheConfig#SLAB_CACHE_OFFHEAP_PERCENTAGE_KEY}) to some
+ * value between 0 and 1 in
  * your <code>hbase-site.xml</code> file. This
  * enables {@link org.apache.hadoop.hbase.io.hfile.DoubleBlockCache}, a facade over
  * {@link org.apache.hadoop.hbase.io.hfile.LruBlockCache} and
@@ -66,7 +67,8 @@
  * multiplied by whatever the setting for <code>-XX:MaxDirectMemorySize</code> is in
  * your <code>hbase-env.sh</code> configuration file and this is what
  * will be used by {@link org.apache.hadoop.hbase.io.hfile.slab.SlabCache} as its offheap store.
- * Onheap store will be whatever the float {@link HConstants#HFILE_BLOCK_CACHE_SIZE_KEY} setting is
+ * Onheap store will be whatever the float
+ * {@link org.apache.hadoop.hbase.HConstants#HFILE_BLOCK_CACHE_SIZE_KEY} setting is
  * (some value between 0 and 1) times the size of the allocated java heap.
  * 
  * <p>Restart (or rolling restart) your cluster for the configs to take effect.  Check logs to
@@ -90,7 +92,8 @@
  * as a strict L2 cache to the L1 LruBlockCache (i.e. on eviction from L1, blocks go to L2), set
  * {@link org.apache.hadoop.hbase.io.hfile.CacheConfig#BUCKET_CACHE_COMBINED_KEY} to false.
  * Also by default, unless you change it,
- * {@link CacheConfig#BUCKET_CACHE_COMBINED_PERCENTAGE_KEY} defaults to <code>0.9</code> (see
+ * {@link org.apache.hadoop.hbase.io.hfile.CacheConfig#BUCKET_CACHE_COMBINED_PERCENTAGE_KEY}
+ * defaults to <code>0.9</code> (see
  * the top of the CacheConfig in the BucketCache defaults section).  This means that whatever
  * size you set for the bucket cache with
  * {@link org.apache.hadoop.hbase.io.hfile.CacheConfig#BUCKET_CACHE_SIZE_KEY},