Mercurial > jdk8-mips64-public > langtools / annotate
src/share/classes/com/sun/tools/javac/tree/DocCommentTable.java@af8417e590f4 (annotated)
src/share/classes/com/sun/tools/javac/tree/DocCommentTable.java
Sun, 17 Feb 2013 16:44:55 -0500
- author
- dholmes
- date
- Sun, 17 Feb 2013 16:44:55 -0500
- changeset 1571
- af8417e590f4
- parent 1409
- 33abf479f202
- child 2525
- 2eb010b6cb22
- permissions
- -rw-r--r--
Merge
| jjg@1280 | 1 | /* |
| jjg@1280 | 2 | * Copyright (c) 2012, Oracle and/or its affiliates. All rights reserved. |
| jjg@1280 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| jjg@1280 | 4 | * |
| jjg@1280 | 5 | * This code is free software; you can redistribute it and/or modify it |
| jjg@1280 | 6 | * under the terms of the GNU General Public License version 2 only, as |
| jjg@1280 | 7 | * published by the Free Software Foundation. Oracle designates this |
| jjg@1280 | 8 | * particular file as subject to the "Classpath" exception as provided |
| jjg@1280 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
| jjg@1280 | 10 | * |
| jjg@1280 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
| jjg@1280 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| jjg@1280 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| jjg@1280 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
| jjg@1280 | 15 | * accompanied this code). |
| jjg@1280 | 16 | * |
| jjg@1280 | 17 | * You should have received a copy of the GNU General Public License version |
| jjg@1280 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
| jjg@1280 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| jjg@1280 | 20 | * |
| jjg@1280 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
| jjg@1280 | 22 | * or visit www.oracle.com if you need additional information or have any |
| jjg@1280 | 23 | * questions. |
| jjg@1280 | 24 | */ |
| jjg@1280 | 25 | package com.sun.tools.javac.tree; |
| jjg@1280 | 26 | |
| jjg@1409 | 27 | import com.sun.source.doctree.ErroneousTree; |
| jjg@1280 | 28 | import com.sun.tools.javac.parser.Tokens.Comment; |
| jjg@1409 | 29 | import com.sun.tools.javac.tree.DCTree.DCDocComment; |
| jjg@1280 | 30 | |
| jjg@1280 | 31 | /** |
| jjg@1280 | 32 | * A table giving the doc comment, if any, for any tree node. |
| jjg@1280 | 33 | * |
| jjg@1280 | 34 | * <p><b>This is NOT part of any supported API. |
| jjg@1280 | 35 | * If you write code that depends on this, you do so at your own |
| jjg@1280 | 36 | * risk. This code and its internal interfaces are subject to change |
| jjg@1280 | 37 | * or deletion without notice.</b> |
| jjg@1280 | 38 | */ |
| jjg@1280 | 39 | public interface DocCommentTable { |
| jjg@1280 | 40 | /** |
| jjg@1280 | 41 | * Check if a tree node has a corresponding doc comment. |
| jjg@1280 | 42 | */ |
| jjg@1280 | 43 | public boolean hasComment(JCTree tree); |
| jjg@1280 | 44 | |
| jjg@1280 | 45 | /** |
| jjg@1280 | 46 | * Get the Comment token containing the doc comment, if any, for a tree node. |
| jjg@1280 | 47 | */ |
| jjg@1280 | 48 | public Comment getComment(JCTree tree); |
| jjg@1280 | 49 | |
| jjg@1280 | 50 | /** |
| jjg@1280 | 51 | * Get the plain text of the doc comment, if any, for a tree node. |
| jjg@1280 | 52 | */ |
| jjg@1280 | 53 | public String getCommentText(JCTree tree); |
| jjg@1280 | 54 | |
| jjg@1280 | 55 | /** |
| jjg@1409 | 56 | * Get the parsed form of the doc comment as a DocTree. If any errors |
| jjg@1409 | 57 | * are detected during parsing, they will be reported via |
| jjg@1409 | 58 | * {@link ErroneousTree ErroneousTree} nodes within the resulting tree. |
| jjg@1409 | 59 | */ |
| jjg@1409 | 60 | public DCDocComment getCommentTree(JCTree tree); |
| jjg@1409 | 61 | |
| jjg@1409 | 62 | /** |
| jjg@1280 | 63 | * Set the Comment to be associated with a tree node. |
| jjg@1280 | 64 | */ |
| jjg@1280 | 65 | public void putComment(JCTree tree, Comment c); |
| jjg@1280 | 66 | } |
