duke@1: /*
ohair@554:  * Copyright (c) 2003, Oracle and/or its affiliates. All rights reserved.
duke@1:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@1:  *
duke@1:  * This code is free software; you can redistribute it and/or modify it
duke@1:  * under the terms of the GNU General Public License version 2 only, as
ohair@554:  * published by the Free Software Foundation.  Oracle designates this
duke@1:  * particular file as subject to the "Classpath" exception as provided
ohair@554:  * by Oracle in the LICENSE file that accompanied this code.
duke@1:  *
duke@1:  * This code is distributed in the hope that it will be useful, but WITHOUT
duke@1:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@1:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
duke@1:  * version 2 for more details (a copy is included in the LICENSE file that
duke@1:  * accompanied this code).
duke@1:  *
duke@1:  * You should have received a copy of the GNU General Public License version
duke@1:  * 2 along with this work; if not, write to the Free Software Foundation,
duke@1:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@1:  *
ohair@554:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@554:  * or visit www.oracle.com if you need additional information or have any
ohair@554:  * questions.
duke@1:  */
duke@1: 
duke@1: package com.sun.tools.doclets.internal.toolkit;
duke@1: 
duke@1: import java.io.*;
duke@1: import com.sun.javadoc.*;
duke@1: 
duke@1: /**
duke@1:  * The interface for writing method output.
duke@1:  *
duke@1:  * This code is not part of an API.
duke@1:  * It is implementation that is subject to change.
duke@1:  * Do not use it as an API
duke@1:  *
duke@1:  * @author Jamie Ho
duke@1:  * @since 1.5
duke@1:  */
duke@1: 
duke@1: public interface MethodWriter {
duke@1: 
duke@1:     /**
duke@1:      * Write the header for the method documentation.
duke@1:      *
duke@1:      * @param classDoc the class that the methods belong to.
duke@1:      * @param header the header to write.
duke@1:      */
duke@1:     public void writeHeader(ClassDoc classDoc, String header);
duke@1: 
duke@1:     /**
duke@1:      * Write the method header for the given method.
duke@1:      *
duke@1:      * @param method the method being documented.
duke@1:      * @param isFirst the flag to indicate whether or not the method is the
duke@1:      *        first to be documented.
duke@1:      */
duke@1:     public void writeMethodHeader(MethodDoc method, boolean isFirst);
duke@1: 
duke@1:     /**
duke@1:      * Write the signature for the given method.
duke@1:      *
duke@1:      * @param method the method being documented.
duke@1:      */
duke@1:     public void writeSignature(MethodDoc method);
duke@1: 
duke@1:     /**
duke@1:      * Write the deprecated output for the given method.
duke@1:      *
duke@1:      * @param method the method being documented.
duke@1:      */
duke@1:     public void writeDeprecated(MethodDoc method);
duke@1: 
duke@1:     /**
duke@1:      * Write the comments for the given method.
duke@1:      *
duke@1:      * @param holder the holder type (not erasure) of the method.
duke@1:      * @param method the method being documented.
duke@1:      */
duke@1:     public void writeComments(Type holder, MethodDoc method);
duke@1: 
duke@1:     /**
duke@1:      * Write the tag output for the given method.
duke@1:      *
duke@1:      * @param method the method being documented.
duke@1:      */
duke@1:     public void writeTags(MethodDoc method);
duke@1: 
duke@1:     /**
duke@1:      * Write the method footer.
duke@1:      */
duke@1:     public void writeMethodFooter();
duke@1: 
duke@1:     /**
duke@1:      * Write the footer for the method documentation.
duke@1:      *
duke@1:      * @param classDoc the class that the methods belong to.
duke@1:      */
duke@1:     public void writeFooter(ClassDoc classDoc);
duke@1: 
duke@1:     /**
duke@1:      * Close the writer.
duke@1:      */
duke@1:     public void close() throws IOException;
duke@1: }