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