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 method 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 MethodWriter {
043:
044: /**
045: * Write the header for the method documentation.
046: *
047: * @param classDoc the class that the methods belong to.
048: * @param header the header to write.
049: */
050: public void writeHeader(ClassDoc classDoc, String header);
051:
052: /**
053: * Write the method header for the given method.
054: *
055: * @param method the method being documented.
056: * @param isFirst the flag to indicate whether or not the method is the
057: * first to be documented.
058: */
059: public void writeMethodHeader(MethodDoc method, boolean isFirst);
060:
061: /**
062: * Write the signature for the given method.
063: *
064: * @param method the method being documented.
065: */
066: public void writeSignature(MethodDoc method);
067:
068: /**
069: * Write the deprecated output for the given method.
070: *
071: * @param method the method being documented.
072: */
073: public void writeDeprecated(MethodDoc method);
074:
075: /**
076: * Write the comments for the given method.
077: *
078: * @param holder the holder type (not erasure) of the method.
079: * @param method the method being documented.
080: */
081: public void writeComments(Type holder, MethodDoc method);
082:
083: /**
084: * Write the tag output for the given method.
085: *
086: * @param method the method being documented.
087: */
088: public void writeTags(MethodDoc method);
089:
090: /**
091: * Write the method footer.
092: */
093: public void writeMethodFooter();
094:
095: /**
096: * Write the footer for the method documentation.
097: *
098: * @param classDoc the class that the methods belong to.
099: */
100: public void writeFooter(ClassDoc classDoc);
101:
102: /**
103: * Close the writer.
104: */
105: public void close() throws IOException;
106: }
|