25
26 package jdk.javadoc.internal.doclets.toolkit;
27
28 import javax.lang.model.element.ExecutableElement;
29 import javax.lang.model.element.TypeElement;
30
31 /**
32 * The interface for writing constructor 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
40 public interface ConstructorWriter {
41
42 /**
43 * Get the constructor details tree header.
44 *
45 * @param typeElement the class being documented
46 * @param memberDetailsTree the content tree representing member details
47 * @return content tree for the constructor details header
48 */
49 Content getConstructorDetailsTreeHeader(TypeElement typeElement,
50 Content memberDetailsTree);
51
52 /**
53 * Get the constructor documentation tree header.
54 *
55 * @param constructor the constructor being documented
56 * @param constructorDetailsTree the content tree representing constructor details
57 * @return content tree for the constructor documentation header
58 */
59 Content getConstructorDocTreeHeader(ExecutableElement constructor,
60 Content constructorDetailsTree);
61
62 /**
63 * Get the signature for the given constructor.
64 *
65 * @param constructor the constructor being documented
66 * @return content tree for the constructor signature
67 */
68 Content getSignature(ExecutableElement constructor);
69
70 /**
71 * Add the deprecated output for the given constructor.
72 *
73 * @param constructor the constructor being documented
74 * @param constructorDocTree content tree to which the deprecated information will be added
75 */
76 void addDeprecated(ExecutableElement constructor, Content constructorDocTree);
77
78 /**
79 * Add the comments for the given constructor.
80 *
|
25
26 package jdk.javadoc.internal.doclets.toolkit;
27
28 import javax.lang.model.element.ExecutableElement;
29 import javax.lang.model.element.TypeElement;
30
31 /**
32 * The interface for writing constructor 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
40 public interface ConstructorWriter {
41
42 /**
43 * Get the constructor details tree header.
44 *
45 * @param memberDetailsTree the content tree representing member details
46 * @return content tree for the constructor details header
47 */
48 Content getConstructorDetailsTreeHeader(Content memberDetailsTree);
49
50 /**
51 * Get the constructor documentation tree header.
52 *
53 * @param constructor the constructor being documented
54 * @return content tree for the constructor documentation header
55 */
56 Content getConstructorDocTreeHeader(ExecutableElement constructor);
57
58 /**
59 * Get the signature for the given constructor.
60 *
61 * @param constructor the constructor being documented
62 * @return content tree for the constructor signature
63 */
64 Content getSignature(ExecutableElement constructor);
65
66 /**
67 * Add the deprecated output for the given constructor.
68 *
69 * @param constructor the constructor being documented
70 * @param constructorDocTree content tree to which the deprecated information will be added
71 */
72 void addDeprecated(ExecutableElement constructor, Content constructorDocTree);
73
74 /**
75 * Add the comments for the given constructor.
76 *
|