jdk8-mips64-public/langtools: src/share/classes/com/sun/tools/doclets/internal/toolkit/MethodWriter.java@90af8d87741f

6851834: Javadoc doclet needs a structured approach to generate the output HTML.
Reviewed-by: jjg

     1 /*

     2  * Copyright (c) 2003, 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  */

    26 package com.sun.tools.doclets.internal.toolkit;

    28 import java.io.*;

    29 import com.sun.javadoc.*;

    31 /**

    32  * The interface for writing method output.

    33  *

    34  * This code is not part of an API.

    35  * It is implementation that is subject to change.

    36  * Do not use it as an API

    37  *

    38  * @author Jamie Ho

    39  * @author Bhavesh Patel (Modified)

    40  * @since 1.5

    41  */

    43 public interface MethodWriter {

    45     /**

    46      * Get the method details tree header.

    47      *

    48      * @param classDoc the class being documented

    49      * @param memberDetailsTree the content tree representing member details

    50      * @return content tree for the method details header

    51      */

    52     public Content getMethodDetailsTreeHeader(ClassDoc classDoc,

    53             Content memberDetailsTree);

    55     /**

    56      * Get the method documentation tree header.

    57      *

    58      * @param method the method being documented

    59      * @param methodDetailsTree the content tree representing method details

    60      * @return content tree for the method documentation header

    61      */

    62     public Content getMethodDocTreeHeader(MethodDoc method,

    63             Content methodDetailsTree);

    65     /**

    66      * Get the signature for the given method.

    67      *

    68      * @param method the method being documented

    69      * @return content tree for the method signature

    70      */

    71     public Content getSignature(MethodDoc method);

    73     /**

    74      * Add the deprecated output for the given method.

    75      *

    76      * @param method the method being documented

    77      * @param methodDocTree content tree to which the deprecated information will be added

    78      */

    79     public void addDeprecated(MethodDoc method, Content methodDocTree);

    81     /**

    82      * Add the comments for the given method.

    83      *

    84      * @param holder the holder type (not erasure) of the method

    85      * @param method the method being documented

    86      * @param methodDocTree the content tree to which the comments will be added

    87      */

    88     public void addComments(Type holder, MethodDoc method, Content methodDocTree);

    90     /**

    91      * Add the tags for the given method.

    92      *

    93      * @param method the method being documented

    94      * @param methodDocTree the content tree to which the tags will be added

    95      */

    96     public void addTags(MethodDoc method, Content methodDocTree);

    98     /**

    99      * Get the method details tree.

   100      *

   101      * @param methodDetailsTree the content tree representing method details

   102      * @return content tree for the method details

   103      */

   104     public Content getMethodDetails(Content methodDetailsTree);

   106     /**

   107      * Get the method documentation.

   108      *

   109      * @param methodDocTree the content tree representing method documentation

   110      * @param isLastContent true if the content to be added is the last content

   111      * @return content tree for the method documentation

   112      */

   113     public Content getMethodDoc(Content methodDocTree, boolean isLastContent);

   115     /**

   116      * Close the writer.

   117      */

   118     public void close() throws IOException;

   119 }

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