equal
deleted
inserted
replaced
1 /* |
1 /* |
2 * Copyright (c) 2011, 2015, Oracle and/or its affiliates. All rights reserved. |
2 * Copyright (c) 2011, 2016, Oracle and/or its affiliates. All rights reserved. |
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
4 * |
4 * |
5 * This code is free software; you can redistribute it and/or modify it |
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 |
6 * under the terms of the GNU General Public License version 2 only, as |
7 * published by the Free Software Foundation. Oracle designates this |
7 * published by the Free Software Foundation. Oracle designates this |
124 * @since 9 |
124 * @since 9 |
125 */ |
125 */ |
126 public abstract DocCommentTree getDocCommentTree(Element e, String relativePath) throws IOException; |
126 public abstract DocCommentTree getDocCommentTree(Element e, String relativePath) throws IOException; |
127 |
127 |
128 /** |
128 /** |
|
129 * Returns a doc tree path containing the doc comment tree of the given file. |
|
130 * The file must be an HTML file, in which case the doc comment tree represents the |
|
131 * contents of the <body> tag, and any enclosing tags are ignored. |
|
132 * Returns {@code null} if no doc comment was found. |
|
133 * Future releases may support additional file types. |
|
134 * |
|
135 * @param fileObject the content container |
|
136 * @return a doc tree path containing the doc comment read from the given file. |
|
137 * |
|
138 * @since 9 |
|
139 */ |
|
140 public abstract DocTreePath getDocTreePath(FileObject fileObject); |
|
141 |
|
142 /** |
129 * Returns the language model element referred to by the leaf node of the given |
143 * Returns the language model element referred to by the leaf node of the given |
130 * {@link DocTreePath}, or {@code null} if unknown. |
144 * {@link DocTreePath}, or {@code null} if unknown. |
131 * @param path the path for the tree node |
145 * @param path the path for the tree node |
132 * @return the element |
146 * @return the element |
133 */ |
147 */ |
173 * sentence breaker |
187 * sentence breaker |
174 * |
188 * |
175 * @since 9 |
189 * @since 9 |
176 */ |
190 */ |
177 public abstract void setBreakIterator(BreakIterator breakiterator); |
191 public abstract void setBreakIterator(BreakIterator breakiterator); |
|
192 |
|
193 /** |
|
194 * Returns a utility object for creating {@code DocTree} objects. |
|
195 * @return a utility object for creating {@code DocTree} objects |
|
196 * |
|
197 * @since 9 |
|
198 */ |
|
199 public abstract DocTreeFactory getDocTreeFactory(); |
178 } |
200 } |