1 /* 2 * Copyright (c) 2003, 2012, 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 26 package com.sun.tools.doclets.internal.toolkit; 27 28 import java.io.*; 29 import com.sun.javadoc.*; 30 31 /** 32 * The interface for writing field output. 33 * 34 * <p><b>This is NOT part of any supported API. 35 * If you write code that depends on this, you do so at your own risk. 36 * This code and its internal interfaces are subject to change or 37 * deletion without notice.</b> 38 * 39 * @author Jamie Ho 40 * @author Bhavesh Patel (Modified) 41 * @since 1.5 42 */ 43 44 public interface FieldWriter { 45 46 /** 47 * Get the field details tree header. 48 * 49 * @param classDoc the class being documented 50 * @param memberDetailsTree the content tree representing member details 51 * @return content tree for the field details header 52 */ 53 public Content getFieldDetailsTreeHeader(ClassDoc classDoc, 54 Content memberDetailsTree); 55 56 /** 57 * Get the field documentation tree header. 58 * 59 * @param field the constructor being documented 60 * @param fieldDetailsTree the content tree representing field details 61 * @return content tree for the field documentation header 62 */ 63 public Content getFieldDocTreeHeader(FieldDoc field, 64 Content fieldDetailsTree); 65 66 /** 67 * Get the signature for the given field. 68 * 69 * @param field the field being documented 70 * @return content tree for the field signature 71 */ 72 public Content getSignature(FieldDoc field); 73 74 /** 75 * Add the deprecated output for the given field. 76 * 77 * @param field the field being documented 78 * @param fieldDocTree content tree to which the deprecated information will be added 79 */ 80 public void addDeprecated(FieldDoc field, Content fieldDocTree); 81 82 /** 83 * Add the comments for the given field. 84 * 85 * @param field the field being documented 86 * @param fieldDocTree the content tree to which the comments will be added 87 */ 88 public void addComments(FieldDoc field, Content fieldDocTree); 89 90 /** 91 * Add the tags for the given field. 92 * 93 * @param field the field being documented 94 * @param fieldDocTree the content tree to which the tags will be added 95 */ 96 public void addTags(FieldDoc field, Content fieldDocTree); 97 98 /** 99 * Get the field details tree. 100 * 101 * @param memberDetailsTree the content tree representing member details 102 * @return content tree for the field details 103 */ 104 public Content getFieldDetails(Content memberDetailsTree); 105 106 /** 107 * Get the field documentation. 108 * 109 * @param fieldDocTree the content tree representing field documentation 110 * @param isLastContent true if the content to be added is the last content 111 * @return content tree for the field documentation 112 */ 113 public Content getFieldDoc(Content fieldDocTree, boolean isLastContent); 114 115 /** 116 * Close the writer. | 1 /* 2 * Copyright (c) 2003, 2016, 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 26 package jdk.javadoc.internal.doclets.toolkit; 27 28 import java.io.*; 29 30 import javax.lang.model.element.TypeElement; 31 import javax.lang.model.element.VariableElement; 32 33 34 /** 35 * The interface for writing field output. 36 * 37 * <p><b>This is NOT part of any supported API. 38 * If you write code that depends on this, you do so at your own risk. 39 * This code and its internal interfaces are subject to change or 40 * deletion without notice.</b> 41 * 42 * @author Jamie Ho 43 * @author Bhavesh Patel (Modified) 44 * @since 1.5 45 */ 46 47 public interface FieldWriter { 48 49 /** 50 * Get the field details tree header. 51 * 52 * @param typeElement the class being documented 53 * @param memberDetailsTree the content tree representing member details 54 * @return content tree for the field details header 55 */ 56 public Content getFieldDetailsTreeHeader(TypeElement typeElement, 57 Content memberDetailsTree); 58 59 /** 60 * Get the field documentation tree header. 61 * 62 * @param field the constructor being documented 63 * @param fieldDetailsTree the content tree representing field details 64 * @return content tree for the field documentation header 65 */ 66 public Content getFieldDocTreeHeader(VariableElement field, 67 Content fieldDetailsTree); 68 69 /** 70 * Get the signature for the given field. 71 * 72 * @param field the field being documented 73 * @return content tree for the field signature 74 */ 75 public Content getSignature(VariableElement field); 76 77 /** 78 * Add the deprecated output for the given field. 79 * 80 * @param field the field being documented 81 * @param fieldDocTree content tree to which the deprecated information will be added 82 */ 83 public void addDeprecated(VariableElement field, Content fieldDocTree); 84 85 /** 86 * Add the comments for the given field. 87 * 88 * @param field the field being documented 89 * @param fieldDocTree the content tree to which the comments will be added 90 */ 91 public void addComments(VariableElement field, Content fieldDocTree); 92 93 /** 94 * Add the tags for the given field. 95 * 96 * @param field the field being documented 97 * @param fieldDocTree the content tree to which the tags will be added 98 */ 99 public void addTags(VariableElement field, Content fieldDocTree); 100 101 /** 102 * Get the field details tree. 103 * 104 * @param memberDetailsTree the content tree representing member details 105 * @return content tree for the field details 106 */ 107 public Content getFieldDetails(Content memberDetailsTree); 108 109 /** 110 * Get the field documentation. 111 * 112 * @param fieldDocTree the content tree representing field documentation 113 * @param isLastContent true if the content to be added is the last content 114 * @return content tree for the field documentation 115 */ 116 public Content getFieldDoc(Content fieldDocTree, boolean isLastContent); 117 118 /** 119 * Close the writer. |