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

     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 annotation type required member 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 AnnotationTypeRequiredMemberWriter {

    44     /**

    45      * Write the header for the member documentation.

    46      *

    47      * @param classDoc the annotation type that the members belong to.

    48      * @param header the header to write.

    49      */

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

    52     /**

    53      * Write the member header for the given member.

    54      *

    55      * @param member the member being documented.

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

    57      *                the first to be documented.

    58      */

    59     public void writeMemberHeader(MemberDoc member, boolean isFirst);

    61     /**

    62      * Write the signature for the given member.

    63      *

    64      * @param member the member being documented.

    65      */

    66     public void writeSignature(MemberDoc member);

    68     /**

    69      * Write the deprecated output for the given member.

    70      *

    71      * @param member the member being documented.

    72      */

    73     public void writeDeprecated(MemberDoc member);

    75     /**

    76      * Write the comments for the given member.

    77      *

    78      * @param member the member being documented.

    79      */

    80     public void writeComments(MemberDoc member);

    82     /**

    83      * Write the tag output for the given member.

    84      *

    85      * @param member the member being documented.

    86      */

    87     public void writeTags(MemberDoc member);

    89     /**

    90      * Write the member footer.

    91      */

    92     public void writeMemberFooter();

    94     /**

    95      * Write the footer for the member documentation.

    96      *

    97      * @param classDoc the class that the member belong to.

    98      */

    99     public void writeFooter(ClassDoc classDoc);

   101     /**

   102      * Close the writer.

   103      */

   104     public void close() throws IOException;

   105 }

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