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

Print this page


   1 /*
   2  * Copyright (c) 2011, 2012, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  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     enum Kind {
  35         /**
  36          * Used for instances of {@link AttributeTree}
  37          * representing an HTML attribute.
  38          */
  39         ATTRIBUTE,
  40 
  41         /**
  42          * Used for instances of {@link AuthorTree}
  43          * representing an @author tag.
  44          */
  45         AUTHOR("author"),
  46 
  47         /**
  48          * Used for instances of {@link LiteralTree}
  49          * representing an @code tag.
  50          */
  51         CODE("code"),
  52 
  53         /**


   1 /*
   2  * Copyright (c) 2011, 2013, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  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 @jdk.Supported
  34 public interface DocTree {
  35     @jdk.Supported
  36     enum Kind {
  37         /**
  38          * Used for instances of {@link AttributeTree}
  39          * representing an HTML attribute.
  40          */
  41         ATTRIBUTE,
  42 
  43         /**
  44          * Used for instances of {@link AuthorTree}
  45          * representing an @author tag.
  46          */
  47         AUTHOR("author"),
  48 
  49         /**
  50          * Used for instances of {@link LiteralTree}
  51          * representing an @code tag.
  52          */
  53         CODE("code"),
  54 
  55         /**