DocCommentTree.java revision 2571:10fc81ac75b4
1/* 2 * Copyright (c) 2011, 2014, 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 26package com.sun.source.doctree; 27 28import java.util.List; 29 30/** 31 * The top level representation of a documentation comment. 32 * 33 * <p> 34 * first-sentence body block-tags 35 * 36 * @since 1.8 37 */ 38@jdk.Exported 39public interface DocCommentTree extends DocTree { 40 /** 41 * Returns the first sentence of a documentation comment. 42 * @return the first sentence of a documentation comment 43 */ 44 List<? extends DocTree> getFirstSentence(); 45 46 /** 47 * Returns the body of a documentation comment, 48 * appearing after the first sentence, and before any block tags. 49 * @return the body of a documentation comment 50 */ 51 List<? extends DocTree> getBody(); 52 53 /** 54 * Returns the block tags for a documentation comment. 55 * @return the block tags of a documentation comment 56 */ 57 List<? extends DocTree> getBlockTags(); 58} 59