View Javadoc
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 method 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 MethodWriter {
45  
46      /**
47       * Get the method 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 method details header
52       */
53      public Content getMethodDetailsTreeHeader(ClassDoc classDoc,
54              Content memberDetailsTree);
55  
56      /**
57       * Get the method documentation tree header.
58       *
59       * @param method the method being documented
60       * @param methodDetailsTree the content tree representing method details
61       * @return content tree for the method documentation header
62       */
63      public Content getMethodDocTreeHeader(MethodDoc method,
64              Content methodDetailsTree);
65  
66      /**
67       * Get the signature for the given method.
68       *
69       * @param method the method being documented
70       * @return content tree for the method signature
71       */
72      public Content getSignature(MethodDoc method);
73  
74      /**
75       * Add the deprecated output for the given method.
76       *
77       * @param method the method being documented
78       * @param methodDocTree content tree to which the deprecated information will be added
79       */
80      public void addDeprecated(MethodDoc method, Content methodDocTree);
81  
82      /**
83       * Add the comments for the given method.
84       *
85       * @param holder the holder type (not erasure) of the method
86       * @param method the method being documented
87       * @param methodDocTree the content tree to which the comments will be added
88       */
89      public void addComments(Type holder, MethodDoc method, Content methodDocTree);
90  
91      /**
92       * Add the tags for the given method.
93       *
94       * @param method the method being documented
95       * @param methodDocTree the content tree to which the tags will be added
96       */
97      public void addTags(MethodDoc method, Content methodDocTree);
98  
99      /**
100      * Get the method details tree.
101      *
102      * @param methodDetailsTree the content tree representing method details
103      * @return content tree for the method details
104      */
105     public Content getMethodDetails(Content methodDetailsTree);
106 
107     /**
108      * Get the method documentation.
109      *
110      * @param methodDocTree the content tree representing method documentation
111      * @param isLastContent true if the content to be added is the last content
112      * @return content tree for the method documentation
113      */
114     public Content getMethodDoc(Content methodDocTree, boolean isLastContent);
115 
116     /**
117      * Close the writer.
118      */
119     public void close() throws IOException;
120 }