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

     1 /*

     2  * Copyright 2003 Sun Microsystems, Inc.  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.  Sun designates this

     8  * particular file as subject to the "Classpath" exception as provided

     9  * by Sun 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,

    22  * CA 95054 USA or visit www.sun.com if you need additional information or

    23  * have any 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  * @since 1.5

    40  */

    42 public interface MethodWriter {

    44     /**

    45      * Write the header for the method documentation.

    46      *

    47      * @param classDoc the class that the methods belong to.

    48      * @param header the header to write.

    49      */

    50     public void writeHeader(ClassDoc classDoc, String header);

    52     /**

    53      * Write the method header for the given method.

    54      *

    55      * @param method the method being documented.

    56      * @param isFirst the flag to indicate whether or not the method is the

    57      *        first to be documented.

    58      */

    59     public void writeMethodHeader(MethodDoc method, boolean isFirst);

    61     /**

    62      * Write the signature for the given method.

    63      *

    64      * @param method the method being documented.

    65      */

    66     public void writeSignature(MethodDoc method);

    68     /**

    69      * Write the deprecated output for the given method.

    70      *

    71      * @param method the method being documented.

    72      */

    73     public void writeDeprecated(MethodDoc method);

    75     /**

    76      * Write the comments for the given method.

    77      *

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

    79      * @param method the method being documented.

    80      */

    81     public void writeComments(Type holder, MethodDoc method);

    83     /**

    84      * Write the tag output for the given method.

    85      *

    86      * @param method the method being documented.

    87      */

    88     public void writeTags(MethodDoc method);

    90     /**

    91      * Write the method footer.

    92      */

    93     public void writeMethodFooter();

    95     /**

    96      * Write the footer for the method documentation.

    97      *

    98      * @param classDoc the class that the methods belong to.

    99      */

   100     public void writeFooter(ClassDoc classDoc);

   102     /**

   103      * Close the writer.

   104      */

   105     public void close() throws IOException;

   106 }

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