< prev index next >

src/jdk.compiler/share/classes/com/sun/source/doctree/DocTree.java

Print this page




  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package com.sun.source.doctree;
  27 
  28 /**
  29  * Common interface for all nodes in a documentation syntax tree.
  30  *
  31  * @since 1.8
  32  */
  33 public interface DocTree {
  34     /**
  35      * Enumerates all kinds of trees.
  36      */
  37     enum Kind {













  38         /**
  39          * Used for instances of {@link AttributeTree}
  40          * representing an HTML attribute.
  41          */
  42         ATTRIBUTE,
  43 
  44         /**
  45          * Used for instances of {@link AuthorTree}
  46          * representing an @author tag.
  47          */
  48         AUTHOR("author"),
  49 
  50         /**
  51          * Used for instances of {@link LiteralTree}
  52          * representing an @code tag.
  53          */
  54         CODE("code"),
  55 
  56         /**
  57          * Used for instances of {@link CommentTree}




  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package com.sun.source.doctree;
  27 
  28 /**
  29  * Common interface for all nodes in a documentation syntax tree.
  30  *
  31  * @since 1.8
  32  */
  33 public interface DocTree {
  34     /**
  35      * Enumerates all kinds of trees.
  36      */
  37     enum Kind {
  38 
  39         /**
  40          * Used for instances of {@link AccessorTree}
  41          * representing an embedded getter JavaDoc.
  42          */
  43         GETTER("getter"),
  44 
  45         /**
  46          * Used for instances of {@link AccessorTree}
  47          * representing an embedded getter JavaDoc.
  48          */
  49         SETTER("setter"),
  50 
  51         /**
  52          * Used for instances of {@link AttributeTree}
  53          * representing an HTML attribute.
  54          */
  55         ATTRIBUTE,
  56 
  57         /**
  58          * Used for instances of {@link AuthorTree}
  59          * representing an @author tag.
  60          */
  61         AUTHOR("author"),
  62 
  63         /**
  64          * Used for instances of {@link LiteralTree}
  65          * representing an @code tag.
  66          */
  67         CODE("code"),
  68 
  69         /**
  70          * Used for instances of {@link CommentTree}


< prev index next >