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 member summary 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 MemberSummaryWriter {
043:
044: /**
045: * Write the member summary header for the given class.
046: *
047: * @param classDoc the class the summary belongs to.
048: */
049: public void writeMemberSummaryHeader(ClassDoc classDoc);
050:
051: /**
052: * Write the member summary for the given class and member.
053: *
054: * @param classDoc the class the summary belongs to.
055: * @param member the member that I am summarizing.
056: * @param firstSentenceTags the tags for the sentence being documented.
057: * @param isFirst true if this is the first member in the list.
058: * @param isLast true if this the last member being documented.
059: */
060: public void writeMemberSummary(ClassDoc classDoc,
061: ProgramElementDoc member, Tag[] firstSentenceTags,
062: boolean isFirst, boolean isLast);
063:
064: /**
065: * Write the member summary footer for the given class.
066: *
067: * @param classDoc the class the summary belongs to.
068: */
069: public void writeMemberSummaryFooter(ClassDoc classDoc);
070:
071: /**
072: * Write the inherited member summary header for the given class.
073: *
074: * @param classDoc the class the summary belongs to.
075: */
076: public void writeInheritedMemberSummaryHeader(ClassDoc classDoc);
077:
078: /**
079: * Write the inherited member summary for the given class and member.
080: *
081: * @param classDoc the class the inherited member belongs to.
082: * @param member the inherited member that I am summarizing.
083: * @param isFirst true if this is the first member in the list.
084: * @param isLast true if this is the last member in the list.
085: */
086: public void writeInheritedMemberSummary(ClassDoc classDoc,
087: ProgramElementDoc member, boolean isFirst, boolean isLast);
088:
089: /**
090: * Write the inherited member summary footer for the given class.
091: *
092: * @param classDoc the class the summary belongs to.
093: */
094: public void writeInheritedMemberSummaryFooter(ClassDoc classDoc);
095:
096: /**
097: * Close the writer.
098: */
099: public void close() throws IOException;
100: }
|