< prev index next >

src/jdk.compiler/share/classes/com/sun/source/util/DocTreeFactory.java

Print this page




  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.util;
  27 
  28 import java.util.List;
  29 
  30 import javax.lang.model.element.Name;
  31 import javax.tools.Diagnostic;
  32 import javax.tools.JavaFileObject;
  33 

  34 import com.sun.source.doctree.AttributeTree;
  35 import com.sun.source.doctree.AttributeTree.ValueKind;
  36 import com.sun.source.doctree.AuthorTree;
  37 import com.sun.source.doctree.CommentTree;
  38 import com.sun.source.doctree.DeprecatedTree;
  39 import com.sun.source.doctree.DocCommentTree;
  40 import com.sun.source.doctree.DocRootTree;
  41 import com.sun.source.doctree.DocTree;

  42 import com.sun.source.doctree.DocTypeTree;
  43 import com.sun.source.doctree.EndElementTree;
  44 import com.sun.source.doctree.EntityTree;
  45 import com.sun.source.doctree.ErroneousTree;
  46 import com.sun.source.doctree.HiddenTree;
  47 import com.sun.source.doctree.IdentifierTree;
  48 import com.sun.source.doctree.IndexTree;
  49 import com.sun.source.doctree.InheritDocTree;
  50 import com.sun.source.doctree.LinkTree;
  51 import com.sun.source.doctree.LiteralTree;
  52 import com.sun.source.doctree.ParamTree;
  53 import com.sun.source.doctree.ProvidesTree;
  54 import com.sun.source.doctree.ReferenceTree;
  55 import com.sun.source.doctree.ReturnTree;
  56 import com.sun.source.doctree.SeeTree;
  57 import com.sun.source.doctree.SerialDataTree;
  58 import com.sun.source.doctree.SerialFieldTree;
  59 import com.sun.source.doctree.SerialTree;
  60 import com.sun.source.doctree.SinceTree;
  61 import com.sun.source.doctree.StartElementTree;


 216      * @param ref the API element being referenced
 217      * @param label an optional label for the link
 218      * @return a {@code LinkTree} object
 219      */
 220     LinkTree newLinkTree(ReferenceTree ref, List<? extends DocTree> label);
 221 
 222     /**
 223      * Create a new {@code LinkPlainTree} object, to represent a {@code {@linkplain } } tag.
 224      * @param ref the API element being referenced
 225      * @param label an optional label for the link
 226      * @return a {@code LinkPlainTree} object
 227      */
 228     LinkTree newLinkPlainTree(ReferenceTree ref, List<? extends DocTree> label);
 229 
 230     /**
 231      * Create a new {@code LiteralTree} object, to represent a {@code {@literal } } tag.
 232      * @param text the content of the tag
 233      * @return a {@code LiteralTree} object
 234      */
 235     LiteralTree newLiteralTree(TextTree text);







 236 
 237     /**
 238      * Create a new {@code ParamTree} object, to represent a {@code @param } tag.
 239      * @param isTypeParameter true if this is a type parameter, and false otherwise
 240      * @param name the parameter being described
 241      * @param description the description of the parameter
 242      * @return a {@code ParamTree} object
 243      */
 244     ParamTree newParamTree(boolean isTypeParameter, IdentifierTree name, List<? extends DocTree> description);
 245 
 246     /**
 247      * Create a new {@code ProvidesTree} object, to represent a {@code @provides } tag.
 248      * @param name the name of the service type
 249      * @param description a description of the service being provided
 250      * @return a {@code ProvidesTree} object
 251      */
 252     ProvidesTree newProvidesTree(ReferenceTree name, List<? extends DocTree> description);
 253 
 254     /**
 255      * Create a new {@code ReferenceTree} object, to represent a reference to an API element.




  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.util;
  27 
  28 import java.util.List;
  29 
  30 import javax.lang.model.element.Name;
  31 import javax.tools.Diagnostic;
  32 import javax.tools.JavaFileObject;
  33 
  34 import com.sun.source.doctree.AccessorTree;
  35 import com.sun.source.doctree.AttributeTree;
  36 import com.sun.source.doctree.AttributeTree.ValueKind;
  37 import com.sun.source.doctree.AuthorTree;
  38 import com.sun.source.doctree.CommentTree;
  39 import com.sun.source.doctree.DeprecatedTree;
  40 import com.sun.source.doctree.DocCommentTree;
  41 import com.sun.source.doctree.DocRootTree;
  42 import com.sun.source.doctree.DocTree;
  43 import com.sun.source.doctree.DocTree.Kind;
  44 import com.sun.source.doctree.DocTypeTree;
  45 import com.sun.source.doctree.EndElementTree;
  46 import com.sun.source.doctree.EntityTree;
  47 import com.sun.source.doctree.ErroneousTree;
  48 import com.sun.source.doctree.HiddenTree;
  49 import com.sun.source.doctree.IdentifierTree;
  50 import com.sun.source.doctree.IndexTree;
  51 import com.sun.source.doctree.InheritDocTree;
  52 import com.sun.source.doctree.LinkTree;
  53 import com.sun.source.doctree.LiteralTree;
  54 import com.sun.source.doctree.ParamTree;
  55 import com.sun.source.doctree.ProvidesTree;
  56 import com.sun.source.doctree.ReferenceTree;
  57 import com.sun.source.doctree.ReturnTree;
  58 import com.sun.source.doctree.SeeTree;
  59 import com.sun.source.doctree.SerialDataTree;
  60 import com.sun.source.doctree.SerialFieldTree;
  61 import com.sun.source.doctree.SerialTree;
  62 import com.sun.source.doctree.SinceTree;
  63 import com.sun.source.doctree.StartElementTree;


 218      * @param ref the API element being referenced
 219      * @param label an optional label for the link
 220      * @return a {@code LinkTree} object
 221      */
 222     LinkTree newLinkTree(ReferenceTree ref, List<? extends DocTree> label);
 223 
 224     /**
 225      * Create a new {@code LinkPlainTree} object, to represent a {@code {@linkplain } } tag.
 226      * @param ref the API element being referenced
 227      * @param label an optional label for the link
 228      * @return a {@code LinkPlainTree} object
 229      */
 230     LinkTree newLinkPlainTree(ReferenceTree ref, List<? extends DocTree> label);
 231 
 232     /**
 233      * Create a new {@code LiteralTree} object, to represent a {@code {@literal } } tag.
 234      * @param text the content of the tag
 235      * @return a {@code LiteralTree} object
 236      */
 237     LiteralTree newLiteralTree(TextTree text);
 238 
 239     /**
 240      * Create a new {@code AccessorTree} object, to represent a {@code @getter} tag.
 241      * @param description the content of the tag
 242      * @return a {@code AccessorTree} object
 243      */
 244     AccessorTree newAccessorTree(Kind kind, List<? extends DocTree> description);
 245 
 246     /**
 247      * Create a new {@code ParamTree} object, to represent a {@code @param } tag.
 248      * @param isTypeParameter true if this is a type parameter, and false otherwise
 249      * @param name the parameter being described
 250      * @param description the description of the parameter
 251      * @return a {@code ParamTree} object
 252      */
 253     ParamTree newParamTree(boolean isTypeParameter, IdentifierTree name, List<? extends DocTree> description);
 254 
 255     /**
 256      * Create a new {@code ProvidesTree} object, to represent a {@code @provides } tag.
 257      * @param name the name of the service type
 258      * @param description a description of the service being provided
 259      * @return a {@code ProvidesTree} object
 260      */
 261     ProvidesTree newProvidesTree(ReferenceTree name, List<? extends DocTree> description);
 262 
 263     /**
 264      * Create a new {@code ReferenceTree} object, to represent a reference to an API element.


< prev index next >