From 0c30aeffb3d21307190d4c60e3619ee9ee6a639a Mon Sep 17 00:00:00 2001
From: Michael McCandless <mikemccand@apache.org>
Date: Mon, 20 Jun 2011 18:26:07 +0000
Subject: [PATCH] fix javadocs

git-svn-id: https://svn.apache.org/repos/asf/lucene/dev/trunk@1137733 13f79535-47bb-0310-9956-ffa450edef68
---
 .../java/org/apache/lucene/index/TieredMergePolicy.java   | 8 ++++++--
 1 file changed, 6 insertions(+), 2 deletions(-)

diff --git a/lucene/src/java/org/apache/lucene/index/TieredMergePolicy.java b/lucene/src/java/org/apache/lucene/index/TieredMergePolicy.java
index 9f24120f3d8..653afad45f8 100644
--- a/lucene/src/java/org/apache/lucene/index/TieredMergePolicy.java
+++ b/lucene/src/java/org/apache/lucene/index/TieredMergePolicy.java
@@ -187,8 +187,12 @@ public class TieredMergePolicy extends MergePolicy {
 
   /** Sets the allowed number of segments per tier.  Smaller
    *  values mean more merging but fewer segments.
-   *  setMaxMergeAtOnce} otherwise you'll hit
-   *  Default is 10.0. */
+   *
+   *  <p><b>NOTE</b>: this value should be >= the {@link
+   *  #setMaxMergeAtOnce} otherwise you'll force too much
+   *  merging to occur.</p>
+   *
+   *  <p>Default is 10.0.</p> */
   public TieredMergePolicy setSegmentsPerTier(double v) {
     if (v < 2.0) {
       throw new IllegalArgumentException("segmentsPerTier must be >= 2.0 (got " + v + ")");