javadoc
=======

.. include:: /ref/targets/autogen/descriptions/javadoc.txt

.. contents::

Configuration options
---------------------

contents
~~~~~~~~

Checks the content of the ``javadoc`` element.

.. code-block:: yaml

    search:
      javadoc:
        contents:
          contains: "javadoc"

.. code-block:: java
    :emphasize-lines: 1-3

    /**
     * This class contains the string javadoc
     */
    class MyClass {
        /**
         * This method doesn't
         */
        public void myMethod() {

        }
    }

owner
~~~~~

Checks what the annotation belongs to. The owner can be a 
:doc:`class`, :doc:`method`, :doc:`field` or :doc:`parameter` target.

.. code-block:: yaml
    
    search:
      javadoc:
        owner:
          method: {}

.. code-block:: java
    :emphasize-lines: 5-7

    /**
     *
     */
    class MyClass {
        /**
         *
         */
        public void myMethod() {

        }
    }

.. include:: /ref/targets/partials/searcher.txt