001: /*
002: * Copyright 2003 Sun Microsystems, Inc. All Rights Reserved.
003: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004: *
005: * This code is free software; you can redistribute it and/or modify it
006: * under the terms of the GNU General Public License version 2 only, as
007: * published by the Free Software Foundation. Sun designates this
008: * particular file as subject to the "Classpath" exception as provided
009: * by Sun in the LICENSE file that accompanied this code.
010: *
011: * This code is distributed in the hope that it will be useful, but WITHOUT
012: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
013: * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
014: * version 2 for more details (a copy is included in the LICENSE file that
015: * accompanied this code).
016: *
017: * You should have received a copy of the GNU General Public License version
018: * 2 along with this work; if not, write to the Free Software Foundation,
019: * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
020: *
021: * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
022: * CA 95054 USA or visit www.sun.com if you need additional information or
023: * have any questions.
024: */
025:
026: package com.sun.tools.doclets.internal.toolkit;
027:
028: import java.io.*;
029: import com.sun.javadoc.*;
030:
031: /**
032: * The interface for writing annotation type required member output.
033: *
034: * This code is not part of an API.
035: * It is implementation that is subject to change.
036: * Do not use it as an API
037: *
038: * @author Jamie Ho
039: * @since 1.5
040: */
041:
042: public interface AnnotationTypeRequiredMemberWriter {
043:
044: /**
045: * Write the header for the member documentation.
046: *
047: * @param classDoc the annotation type that the members belong to.
048: * @param header the header to write.
049: */
050: public void writeHeader(ClassDoc classDoc, String header);
051:
052: /**
053: * Write the member header for the given member.
054: *
055: * @param member the member being documented.
056: * @param isFirst the flag to indicate whether or not the member is
057: * the first to be documented.
058: */
059: public void writeMemberHeader(MemberDoc member, boolean isFirst);
060:
061: /**
062: * Write the signature for the given member.
063: *
064: * @param member the member being documented.
065: */
066: public void writeSignature(MemberDoc member);
067:
068: /**
069: * Write the deprecated output for the given member.
070: *
071: * @param member the member being documented.
072: */
073: public void writeDeprecated(MemberDoc member);
074:
075: /**
076: * Write the comments for the given member.
077: *
078: * @param member the member being documented.
079: */
080: public void writeComments(MemberDoc member);
081:
082: /**
083: * Write the tag output for the given member.
084: *
085: * @param member the member being documented.
086: */
087: public void writeTags(MemberDoc member);
088:
089: /**
090: * Write the member footer.
091: */
092: public void writeMemberFooter();
093:
094: /**
095: * Write the footer for the member documentation.
096: *
097: * @param classDoc the class that the member belong to.
098: */
099: public void writeFooter(ClassDoc classDoc);
100:
101: /**
102: * Close the writer.
103: */
104: public void close() throws IOException;
105: }
|