1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/src/share/classes/com/sun/tools/doclets/internal/toolkit/MethodWriter.java Sat Dec 01 00:00:00 2007 +0000
1.3 @@ -0,0 +1,106 @@
1.4 +/*
1.5 + * Copyright 2003 Sun Microsystems, Inc. All Rights Reserved.
1.6 + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
1.7 + *
1.8 + * This code is free software; you can redistribute it and/or modify it
1.9 + * under the terms of the GNU General Public License version 2 only, as
1.10 + * published by the Free Software Foundation. Sun designates this
1.11 + * particular file as subject to the "Classpath" exception as provided
1.12 + * by Sun in the LICENSE file that accompanied this code.
1.13 + *
1.14 + * This code is distributed in the hope that it will be useful, but WITHOUT
1.15 + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
1.16 + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
1.17 + * version 2 for more details (a copy is included in the LICENSE file that
1.18 + * accompanied this code).
1.19 + *
1.20 + * You should have received a copy of the GNU General Public License version
1.21 + * 2 along with this work; if not, write to the Free Software Foundation,
1.22 + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
1.23 + *
1.24 + * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
1.25 + * CA 95054 USA or visit www.sun.com if you need additional information or
1.26 + * have any questions.
1.27 + */
1.28 +
1.29 +package com.sun.tools.doclets.internal.toolkit;
1.30 +
1.31 +import java.io.*;
1.32 +import com.sun.javadoc.*;
1.33 +
1.34 +/**
1.35 + * The interface for writing method output.
1.36 + *
1.37 + * This code is not part of an API.
1.38 + * It is implementation that is subject to change.
1.39 + * Do not use it as an API
1.40 + *
1.41 + * @author Jamie Ho
1.42 + * @since 1.5
1.43 + */
1.44 +
1.45 +public interface MethodWriter {
1.46 +
1.47 + /**
1.48 + * Write the header for the method documentation.
1.49 + *
1.50 + * @param classDoc the class that the methods belong to.
1.51 + * @param header the header to write.
1.52 + */
1.53 + public void writeHeader(ClassDoc classDoc, String header);
1.54 +
1.55 + /**
1.56 + * Write the method header for the given method.
1.57 + *
1.58 + * @param method the method being documented.
1.59 + * @param isFirst the flag to indicate whether or not the method is the
1.60 + * first to be documented.
1.61 + */
1.62 + public void writeMethodHeader(MethodDoc method, boolean isFirst);
1.63 +
1.64 + /**
1.65 + * Write the signature for the given method.
1.66 + *
1.67 + * @param method the method being documented.
1.68 + */
1.69 + public void writeSignature(MethodDoc method);
1.70 +
1.71 + /**
1.72 + * Write the deprecated output for the given method.
1.73 + *
1.74 + * @param method the method being documented.
1.75 + */
1.76 + public void writeDeprecated(MethodDoc method);
1.77 +
1.78 + /**
1.79 + * Write the comments for the given method.
1.80 + *
1.81 + * @param holder the holder type (not erasure) of the method.
1.82 + * @param method the method being documented.
1.83 + */
1.84 + public void writeComments(Type holder, MethodDoc method);
1.85 +
1.86 + /**
1.87 + * Write the tag output for the given method.
1.88 + *
1.89 + * @param method the method being documented.
1.90 + */
1.91 + public void writeTags(MethodDoc method);
1.92 +
1.93 + /**
1.94 + * Write the method footer.
1.95 + */
1.96 + public void writeMethodFooter();
1.97 +
1.98 + /**
1.99 + * Write the footer for the method documentation.
1.100 + *
1.101 + * @param classDoc the class that the methods belong to.
1.102 + */
1.103 + public void writeFooter(ClassDoc classDoc);
1.104 +
1.105 + /**
1.106 + * Close the writer.
1.107 + */
1.108 + public void close() throws IOException;
1.109 +}
