// Licensed to the Software Freedom Conservancy (SFC) under one
// or more contributor license agreements.  See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership.  The SFC licenses this file
// to you 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.

package org.openqa.selenium.support;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Used to mark a field on a Page Object to indicate an alternative mechanism for locating the
 * element or a list of elements. Used in conjunction with
 * {@link org.openqa.selenium.support.PageFactory}
 * this allows users to quickly and easily create PageObjects.
 *
 * It can be used on a types as well, but will not be processed by default.
 *
 * <p>
 * You can either use this annotation by specifying both "how" and "using" or by specifying one of
 * the location strategies (eg: "id") with an appropriate value to use. Both options will delegate
 * down to the matching {@link org.openqa.selenium.By} methods in By class.
 *
 * For example, these two annotations point to the same element:
 *
 * <pre>{@code
 * &#64;FindBy(id = "foobar") WebElement foobar;
 * &#64;FindBy(how = How.ID, using = "foobar") WebElement foobar;
 * }</pre>
 *
 * and these two annotations point to the same list of elements:
 *
 * <pre>{@code
 * &#64;FindBy(tagName = "a") List<WebElement> links;
 * &#64;FindBy(how = How.TAG_NAME, using = "a") List<WebElement> links;
 * }</pre>
 */
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD, ElementType.TYPE})
public @interface FindBy {
  How how() default How.UNSET;

  String using() default "";

  String id() default "";

  String name() default "";

  String className() default "";

  String css() default "";

  String tagName() default "";

  String linkText() default "";

  String partialLinkText() default "";

  String xpath() default "";
}

@@ -1004,16 +1004,19 @@
 %0A/**%0A * 
+%3Cp%3E
 Used to 
@@ -1271,23 +1271,30 @@
 Objects.
+%3C/p%3E
 %0A *%0A * 
+%3Cp%3E
 It can b
@@ -1357,16 +1357,20 @@
 default.
+%3C/p%3E
 %0A *%0A * %3C
@@ -1645,23 +1645,30 @@
 y class.
+%3C/p%3E
 %0A *%0A * 
+%3Cp%3E
 For exam
@@ -1720,16 +1720,20 @@
 element:
+%3C/p%3E
 %0A *%0A * %3C
@@ -1727,39 +1727,46 @@
 :%3C/p%3E%0A *%0A * %3Cpre
-%3E%7B@
+ class=%22
 code
+%22%3E
 %0A * &#64;FindBy(
@@ -1864,25 +1864,24 @@
  foobar;%0A * 
-%7D
 %3C/pre%3E%0A *%0A *
@@ -1881,16 +1881,19 @@
 %3E%0A *%0A * 
+%3Cp%3E
 and thes
@@ -1945,16 +1945,20 @@
 lements:
+%3C/p%3E
 %0A *%0A * %3C
@@ -1964,15 +1964,22 @@
 %3Cpre
-%3E%7B@
+ class=%22
 code
+%22%3E
 %0A * 
@@ -2001,33 +2001,36 @@
 Name = %22a%22) List
-%3C
+&lt;
 WebElement%3E link
@@ -2015,33 +2015,36 @@
 st&lt;WebElement
-%3E
+&gt;
  links;%0A * &#64;
@@ -2087,17 +2087,20 @@
 a%22) List
-%3C
+&lt;
 WebEleme
@@ -2101,17 +2101,20 @@
 bElement
-%3E
+&gt;
  links;%0A
@@ -2116,17 +2116,16 @@
 nks;%0A * 
-%7D
 %3C/pre%3E%0A 

Fix javadoc for @FindBy ('@' was not rendered in code samples) (#3430)