This is NOT part of any supported API. - * If you write code that depends on this, you do so at your own risk. - * This code and its internal interfaces are subject to change or - * deletion without notice. - * - * @author Jamie Ho - * @author Bhavesh Patel (Modified) - * @since 1.7 - */ - -public interface PropertyWriter { - - /** - * Get the property details tree header. - * - * @param classDoc the class being documented - * @param memberDetailsTree the content tree representing member details - * @return content tree for the property details header - */ - public Content getPropertyDetailsTreeHeader(ClassDoc classDoc, - Content memberDetailsTree); - - /** - * Get the property documentation tree header. - * - * @param property the property being documented - * @param propertyDetailsTree the content tree representing property details - * @return content tree for the property documentation header - */ - public Content getPropertyDocTreeHeader(MethodDoc property, - Content propertyDetailsTree); - - /** - * Get the signature for the given property. - * - * @param property the property being documented - * @return content tree for the property signature - */ - public Content getSignature(MethodDoc property); - - /** - * Add the deprecated output for the given property. - * - * @param property the property being documented - * @param propertyDocTree content tree to which the deprecated information will be added - */ - public void addDeprecated(MethodDoc property, Content propertyDocTree); - - /** - * Add the comments for the given property. - * - * @param property the property being documented - * @param propertyDocTree the content tree to which the comments will be added - */ - public void addComments(MethodDoc property, Content propertyDocTree); - - /** - * Add the tags for the given property. - * - * @param property the property being documented - * @param propertyDocTree the content tree to which the tags will be added - */ - public void addTags(MethodDoc property, Content propertyDocTree); - - /** - * Get the property details tree. - * - * @param memberDetailsTree the content tree representing member details - * @return content tree for the property details - */ - public Content getPropertyDetails(Content memberDetailsTree); - - /** - * Get the property documentation. - * - * @param propertyDocTree the content tree representing property documentation - * @param isLastContent true if the content to be added is the last content - * @return content tree for the property documentation - */ - public Content getPropertyDoc(Content propertyDocTree, boolean isLastContent); - - /** - * Close the writer. - */ - public void close() throws IOException; -} --- /dev/null Fri Jan 22 12:19:21 2016 +++ new/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/PropertyWriter.java Fri Jan 22 12:19:21 2016 @@ -0,0 +1,121 @@ +/* + * Copyright (c) 2003, 2016, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. Oracle designates this + * particular file as subject to the "Classpath" exception as provided + * by Oracle in the LICENSE file that accompanied this code. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + +package jdk.javadoc.internal.doclets.toolkit; + +import java.io.*; + +import javax.lang.model.element.ExecutableElement; +import javax.lang.model.element.TypeElement; + +/** + * The interface for writing property output. + * + *
This is NOT part of any supported API. + * If you write code that depends on this, you do so at your own risk. + * This code and its internal interfaces are subject to change or + * deletion without notice. + * + * @author Jamie Ho + * @author Bhavesh Patel (Modified) + * @since 1.7 + */ + +public interface PropertyWriter { + + /** + * Get the property details tree header. + * + * @param typeElement the class being documented + * @param memberDetailsTree the content tree representing member details + * @return content tree for the property details header + */ + public Content getPropertyDetailsTreeHeader(TypeElement typeElement, + Content memberDetailsTree); + + /** + * Get the property documentation tree header. + * + * @param property the property being documented + * @param propertyDetailsTree the content tree representing property details + * @return content tree for the property documentation header + */ + public Content getPropertyDocTreeHeader(ExecutableElement property, + Content propertyDetailsTree); + + /** + * Get the signature for the given property. + * + * @param property the property being documented + * @return content tree for the property signature + */ + public Content getSignature(ExecutableElement property); + + /** + * Add the deprecated output for the given property. + * + * @param property the property being documented + * @param propertyDocTree content tree to which the deprecated information will be added + */ + public void addDeprecated(ExecutableElement property, Content propertyDocTree); + + /** + * Add the comments for the given property. + * + * @param property the property being documented + * @param propertyDocTree the content tree to which the comments will be added + */ + public void addComments(ExecutableElement property, Content propertyDocTree); + + /** + * Add the tags for the given property. + * + * @param property the property being documented + * @param propertyDocTree the content tree to which the tags will be added + */ + public void addTags(ExecutableElement property, Content propertyDocTree); + + /** + * Get the property details tree. + * + * @param memberDetailsTree the content tree representing member details + * @return content tree for the property details + */ + public Content getPropertyDetails(Content memberDetailsTree); + + /** + * Get the property documentation. + * + * @param propertyDocTree the content tree representing property documentation + * @param isLastContent true if the content to be added is the last content + * @return content tree for the property documentation + */ + public Content getPropertyDoc(Content propertyDocTree, boolean isLastContent); + + /** + * Close the writer. + */ + public void close() throws IOException; +}