Mercurial > jdk8-mips64-public > langtools / file comparison

comparison: src/share/classes/com/sun/tools/doclets/internal/toolkit/ConstructorWriter.java

src/share/classes/com/sun/tools/doclets/internal/toolkit/ConstructorWriter.java

changeset 766
90af8d87741f
parent 554
9d9f26857129
child 798
4868a36f6fd8
equal deleted inserted replaced
758:bcbc86cc5b31 766:90af8d87741f
34 * This code is not part of an API. 34 * This code is not part of an API.
35 * It is implementation that is subject to change. 35 * It is implementation that is subject to change.
36 * Do not use it as an API 36 * Do not use it as an API
37 * 37 *
38 * @author Jamie Ho 38 * @author Jamie Ho
39 * @author Bhavesh Patel (Modified)
39 * @since 1.5 40 * @since 1.5
40 */ 41 */
41 42
42 public interface ConstructorWriter { 43 public interface ConstructorWriter {
43 44
44 /** 45 /**
45 * Write the header for the constructor documentation. 46 * Get the constructor details tree header.
46 * 47 *
47 * @param classDoc the class that the constructors belong to. 48 * @param classDoc the class being documented
48 * @param header the header to write. 49 * @param memberDetailsTree the content tree representing member details
50 * @return content tree for the constructor details header
49 */ 51 */
50 public void writeHeader(ClassDoc classDoc, String header); 52 public Content getConstructorDetailsTreeHeader(ClassDoc classDoc,
53 Content memberDetailsTree);
51 54
52 /** 55 /**
53 * Write the constructor header for the given constructor. 56 * Get the constructor documentation tree header.
54 * 57 *
55 * @param constructor the constructor being documented. 58 * @param constructor the constructor being documented
56 * @param isFirst the flag to indicate whether or not the constructor is the 59 * @param constructorDetailsTree the content tree representing constructor details
57 * first to be documented. 60 * @return content tree for the constructor documentation header
58 */ 61 */
59 public void writeConstructorHeader(ConstructorDoc constructor, boolean isFirst); 62 public Content getConstructorDocTreeHeader(ConstructorDoc constructor,
63 Content constructorDetailsTree);
60 64
61 /** 65 /**
62 * Write the signature for the given constructor. 66 * Get the signature for the given constructor.
63 * 67 *
64 * @param constructor the constructor being documented. 68 * @param constructor the constructor being documented
69 * @return content tree for the constructor signature
65 */ 70 */
66 public void writeSignature(ConstructorDoc constructor); 71 public Content getSignature(ConstructorDoc constructor);
67 72
68 /** 73 /**
69 * Write the deprecated output for the given constructor. 74 * Add the deprecated output for the given constructor.
70 * 75 *
71 * @param constructor the constructor being documented. 76 * @param constructor the constructor being documented
77 * @param constructorDocTree content tree to which the deprecated information will be added
72 */ 78 */
73 public void writeDeprecated(ConstructorDoc constructor); 79 public void addDeprecated(ConstructorDoc constructor, Content constructorDocTree);
74 80
75 /** 81 /**
76 * Write the comments for the given constructor. 82 * Add the comments for the given constructor.
77 * 83 *
78 * @param constructor the constructor being documented. 84 * @param constructor the constructor being documented
85 * @param constructorDocTree the content tree to which the comments will be added
79 */ 86 */
80 public void writeComments(ConstructorDoc constructor); 87 public void addComments(ConstructorDoc constructor, Content constructorDocTree);
81 88
82 /** 89 /**
83 * Write the tag output for the given constructor. 90 * Add the tags for the given constructor.
84 * 91 *
85 * @param constructor the constructor being documented. 92 * @param constructor the constructor being documented
93 * @param constructorDocTree the content tree to which the tags will be added
86 */ 94 */
87 public void writeTags(ConstructorDoc constructor); 95 public void addTags(ConstructorDoc constructor, Content constructorDocTree);
88 96
89 /** 97 /**
90 * Write the constructor footer. 98 * Get the constructor details tree.
99 *
100 * @param memberDetailsTree the content tree representing member details
101 * @return content tree for the constructor details
91 */ 102 */
92 public void writeConstructorFooter(); 103 public Content getConstructorDetails(Content memberDetailsTree);
93 104
94 /** 105 /**
95 * Write the footer for the constructor documentation. 106 * Get the constructor documentation.
96 * 107 *
97 * @param classDoc the class that the constructors belong to. 108 * @param constructorDocTree the content tree representing constructor documentation
109 * @param isLastContent true if the content to be added is the last content
110 * @return content tree for the constructor documentation
98 */ 111 */
99 public void writeFooter(ClassDoc classDoc); 112 public Content getConstructorDoc(Content constructorDocTree, boolean isLastContent);
100 113
101 /** 114 /**
102 * Let the writer know whether a non public constructor was found. 115 * Let the writer know whether a non public constructor was found.
103 * 116 *
104 * @param foundNonPubConstructor true if we found a non public constructor. 117 * @param foundNonPubConstructor true if we found a non public constructor.

Mercurial Repository: jdk8-mips64-public/langtools

mercurial