Mercurial > jdk8-mips64-public > langtools / annotate
src/share/classes/com/sun/tools/doclets/internal/toolkit/MethodWriter.java@25e14ad23cef (annotated)
src/share/classes/com/sun/tools/doclets/internal/toolkit/MethodWriter.java
Wed, 10 Oct 2012 16:48:21 -0700
- author
- jjg
- date
- Wed, 10 Oct 2012 16:48:21 -0700
- changeset 1359
- 25e14ad23cef
- parent 798
- 4868a36f6fd8
- child 2525
- 2eb010b6cb22
- permissions
- -rw-r--r--
8000665: fix "internal API" comments on javadoc files
Reviewed-by: darcy
| duke@1 | 1 | /* |
| jjg@1359 | 2 | * Copyright (c) 2003, 2012, Oracle and/or its affiliates. All rights reserved. |
| duke@1 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| duke@1 | 4 | * |
| duke@1 | 5 | * This code is free software; you can redistribute it and/or modify it |
| duke@1 | 6 | * under the terms of the GNU General Public License version 2 only, as |
| ohair@554 | 7 | * published by the Free Software Foundation. Oracle designates this |
| duke@1 | 8 | * particular file as subject to the "Classpath" exception as provided |
| ohair@554 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
| duke@1 | 10 | * |
| duke@1 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
| duke@1 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| duke@1 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| duke@1 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
| duke@1 | 15 | * accompanied this code). |
| duke@1 | 16 | * |
| duke@1 | 17 | * You should have received a copy of the GNU General Public License version |
| duke@1 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
| duke@1 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| duke@1 | 20 | * |
| ohair@554 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
| ohair@554 | 22 | * or visit www.oracle.com if you need additional information or have any |
| ohair@554 | 23 | * questions. |
| duke@1 | 24 | */ |
| duke@1 | 25 | |
| duke@1 | 26 | package com.sun.tools.doclets.internal.toolkit; |
| duke@1 | 27 | |
| duke@1 | 28 | import java.io.*; |
| duke@1 | 29 | import com.sun.javadoc.*; |
| duke@1 | 30 | |
| duke@1 | 31 | /** |
| duke@1 | 32 | * The interface for writing method output. |
| duke@1 | 33 | * |
| jjg@1359 | 34 | * <p><b>This is NOT part of any supported API. |
| jjg@1359 | 35 | * If you write code that depends on this, you do so at your own risk. |
| jjg@1359 | 36 | * This code and its internal interfaces are subject to change or |
| jjg@1359 | 37 | * deletion without notice.</b> |
| duke@1 | 38 | * |
| duke@1 | 39 | * @author Jamie Ho |
| bpatel@766 | 40 | * @author Bhavesh Patel (Modified) |
| duke@1 | 41 | * @since 1.5 |
| duke@1 | 42 | */ |
| duke@1 | 43 | |
| duke@1 | 44 | public interface MethodWriter { |
| duke@1 | 45 | |
| duke@1 | 46 | /** |
| bpatel@766 | 47 | * Get the method details tree header. |
| duke@1 | 48 | * |
| bpatel@766 | 49 | * @param classDoc the class being documented |
| bpatel@766 | 50 | * @param memberDetailsTree the content tree representing member details |
| bpatel@766 | 51 | * @return content tree for the method details header |
| duke@1 | 52 | */ |
| bpatel@766 | 53 | public Content getMethodDetailsTreeHeader(ClassDoc classDoc, |
| bpatel@766 | 54 | Content memberDetailsTree); |
| duke@1 | 55 | |
| duke@1 | 56 | /** |
| bpatel@766 | 57 | * Get the method documentation tree header. |
| duke@1 | 58 | * |
| bpatel@766 | 59 | * @param method the method being documented |
| bpatel@766 | 60 | * @param methodDetailsTree the content tree representing method details |
| bpatel@766 | 61 | * @return content tree for the method documentation header |
| duke@1 | 62 | */ |
| bpatel@766 | 63 | public Content getMethodDocTreeHeader(MethodDoc method, |
| bpatel@766 | 64 | Content methodDetailsTree); |
| duke@1 | 65 | |
| duke@1 | 66 | /** |
| bpatel@766 | 67 | * Get the signature for the given method. |
| duke@1 | 68 | * |
| bpatel@766 | 69 | * @param method the method being documented |
| bpatel@766 | 70 | * @return content tree for the method signature |
| duke@1 | 71 | */ |
| bpatel@766 | 72 | public Content getSignature(MethodDoc method); |
| duke@1 | 73 | |
| duke@1 | 74 | /** |
| bpatel@766 | 75 | * Add the deprecated output for the given method. |
| duke@1 | 76 | * |
| bpatel@766 | 77 | * @param method the method being documented |
| bpatel@766 | 78 | * @param methodDocTree content tree to which the deprecated information will be added |
| duke@1 | 79 | */ |
| bpatel@766 | 80 | public void addDeprecated(MethodDoc method, Content methodDocTree); |
| duke@1 | 81 | |
| duke@1 | 82 | /** |
| bpatel@766 | 83 | * Add the comments for the given method. |
| duke@1 | 84 | * |
| bpatel@766 | 85 | * @param holder the holder type (not erasure) of the method |
| bpatel@766 | 86 | * @param method the method being documented |
| bpatel@766 | 87 | * @param methodDocTree the content tree to which the comments will be added |
| duke@1 | 88 | */ |
| bpatel@766 | 89 | public void addComments(Type holder, MethodDoc method, Content methodDocTree); |
| duke@1 | 90 | |
| duke@1 | 91 | /** |
| bpatel@766 | 92 | * Add the tags for the given method. |
| duke@1 | 93 | * |
| bpatel@766 | 94 | * @param method the method being documented |
| bpatel@766 | 95 | * @param methodDocTree the content tree to which the tags will be added |
| duke@1 | 96 | */ |
| bpatel@766 | 97 | public void addTags(MethodDoc method, Content methodDocTree); |
| duke@1 | 98 | |
| duke@1 | 99 | /** |
| bpatel@766 | 100 | * Get the method details tree. |
| bpatel@766 | 101 | * |
| bpatel@766 | 102 | * @param methodDetailsTree the content tree representing method details |
| bpatel@766 | 103 | * @return content tree for the method details |
| duke@1 | 104 | */ |
| bpatel@766 | 105 | public Content getMethodDetails(Content methodDetailsTree); |
| duke@1 | 106 | |
| duke@1 | 107 | /** |
| bpatel@766 | 108 | * Get the method documentation. |
| duke@1 | 109 | * |
| bpatel@766 | 110 | * @param methodDocTree the content tree representing method documentation |
| bpatel@766 | 111 | * @param isLastContent true if the content to be added is the last content |
| bpatel@766 | 112 | * @return content tree for the method documentation |
| duke@1 | 113 | */ |
| bpatel@766 | 114 | public Content getMethodDoc(Content methodDocTree, boolean isLastContent); |
| duke@1 | 115 | |
| duke@1 | 116 | /** |
| duke@1 | 117 | * Close the writer. |
| duke@1 | 118 | */ |
| duke@1 | 119 | public void close() throws IOException; |
| duke@1 | 120 | } |
