/**
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
 * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
 * specific language governing permissions and limitations under the License.
 *
 * Copyright 2012-2015 the original author or authors.
 */
package org.assertj.core.api;

import org.assertj.core.data.Offset;

/**
 * Assertion methods applicable to floating-point <code>{@link Number}</code>s.
 * @param <S> the "self" type of this assertion class. Please read &quot;<a href="http://bit.ly/1IZIRcY" target="_blank">Emulating
 *          'self types' using Java Generics to simplify fluent API implementation</a>&quot; for more details.
 * @param <A> the type of the "actual" value.
 * 
 * @author Alex Ruiz
 * @author Yvonne Wang
 * @author Mikhail Mazursky
 */
public interface FloatingPointNumberAssert<S extends  FloatingPointNumberAssert<S, A>, A extends Number> extends NumberAssert<S, A> {

  /**
   * Verifies that the actual value is close to the given one by less than the given offset.<br>
   * If difference is equal to offset value, assertion is considered valid.
   * <p>
   * Example with double:
   * <pre><code class='java'> // assertion will pass:
   * assertThat(8.1).isEqualTo(new Double(8.0), offset(0.2));
   *
   * // if difference is exactly equals to the offset (0.1), it's ok
   * assertThat(8.1).isEqualTo(new Double(8.0), offset(0.1));
   *
   * // within is an alias of offset
   * assertThat(8.1).isEqualTo(new Double(8.0), within(0.1));
   *
   * // assertion will fail
   * assertThat(8.1).isEqualTo(new Double(8.0), offset(0.01));</code></pre>
   *
   * @param expected the given value to compare the actual value to.
   * @param offset the given positive offset.
   * @return {@code this} assertion object.
   * @throws NullPointerException if the given offset is {@code null}.
   * @throws NullPointerException if the expected number is {@code null}.
   * @throws AssertionError if the actual value is not equal to the given one.
   */
  S isEqualTo(A expected, Offset<A> offset);

  /**
   * Verifies that the actual number is close to the given one within the given offset.<br>
   * If difference is equal to offset value, assertion is considered valid.
   * <p>
   * Example with double:
   * <pre><code class='java'> // assertions will pass:
   * assertThat(8.1).isCloseTo(new Double(8.0), within(0.2));
   *
   * // you can use offset if you prefer
   * assertThat(8.1).isCloseTo(new Double(8.0), offset(0.2));
   *
   * // if difference is exactly equals to the offset (0.1), it's ok
   * assertThat(8.1).isCloseTo(new Double(8.0), within(0.1));
   *
   * // assertion will fail
   * assertThat(8.1).isCloseTo(new Double(8.0), within(0.01));</code></pre>
   *
   * @param expected the given number to compare the actual value to.
   * @param offset the given positive offset.
   * @return {@code this} assertion object.
   * @throws NullPointerException if the given offset is {@code null}.
   * @throws NullPointerException if the expected number is {@code null}.
   * @throws AssertionError if the actual value is not equal to the given one.
   */
  S isCloseTo(A expected, Offset<A> offset);

  /**
   * Verifies that the actual value is equal to {@code NaN}.
   * @return this assertion object.
   * @throws AssertionError if the actual value is not equal to {@code NaN}.
   */
  S isNaN();

  /**
   * Verifies that the actual value is not equal to {@code NaN}.
   * @return this assertion object.
   * @throws AssertionError if the actual value is equal to {@code NaN}.
   */
  S isNotNaN();
}

@@ -3572,206 +3572,875 @@
   * 
-@return this assertion object.%0A   * @throws AssertionError if the actual value is not equal to %7B@code NaN%7D.%0A   */%0A  S isNaN();%0A%0A  /**%0A   * Verifies that the actual value is not equal to %7B@code NaN%7D.
+%3Cp%3E%0A   * Example:%0A   * %3Cpre%3E%3Ccode class='java'%3E // assertions will pass%0A   * assertThat(Double.NaN).isNaN();%0A   * assertThat(0.0 / 0.0).isNaN();%0A   * assertThat(0.0F * Float.POSITIVE_INFINITY).isNaN();%0A   * %0A   * // assertions will fail%0A   * assertThat(1.0).isNaN();%0A   * assertThat(-1.0F).isNaN();%3C/code%3E%3C/pre%3E%0A   * %3C/p%3E%0A   * @return this assertion object.%0A   * @throws AssertionError if the actual value is not equal to %7B@code NaN%7D.%0A   */%0A  S isNaN();%0A%0A  /**%0A   * Verifies that the actual value is not equal to %7B@code NaN%7D.%0A   * %3Cp%3E%0A   * Example:%0A   * %3Cpre%3E%3Ccode class='java'%3E // assertions will pass%0A   * assertThat(1.0).isNotNaN();%0A   * assertThat(-1.0F).isNotNaN();%0A   * %0A   * // assertions will fail%0A   * assertThat(Double.NaN).isNotNaN();%0A   * assertThat(0.0 / 0.0).isNotNaN();%0A   * assertThat(0.0F * Float.POSITIVE_INFINITY).isNotNaN();%3C/code%3E%3C/pre%3E%0A   * %3C/p%3E
 %0A   

add missing javadoc examples to FloatingPointNumberAssert