src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/MethodWriter.java

Print this page

        

*** 1,7 **** /* ! * Copyright (c) 2003, 2012, Oracle and/or its affiliates. All rights reserved. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as * published by the Free Software Foundation. Oracle designates this --- 1,7 ---- /* ! * Copyright (c) 2003, 2016, Oracle and/or its affiliates. All rights reserved. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as * published by the Free Software Foundation. Oracle designates this
*** 21,35 **** * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA * or visit www.oracle.com if you need additional information or have any * questions. */ ! package com.sun.tools.doclets.internal.toolkit; import java.io.*; - import com.sun.javadoc.*; /** * The interface for writing method output. * * <p><b>This is NOT part of any supported API. * If you write code that depends on this, you do so at your own risk. --- 21,38 ---- * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA * or visit www.oracle.com if you need additional information or have any * questions. */ ! package jdk.javadoc.internal.doclets.toolkit; import java.io.*; + import javax.lang.model.element.ExecutableElement; + import javax.lang.model.element.TypeElement; + import javax.lang.model.type.TypeMirror; + /** * The interface for writing method output. * * <p><b>This is NOT part of any supported API. * If you write code that depends on this, you do so at your own risk.
*** 44,102 **** public interface MethodWriter { /** * Get the method details tree header. * ! * @param classDoc the class being documented * @param memberDetailsTree the content tree representing member details * @return content tree for the method details header */ ! public Content getMethodDetailsTreeHeader(ClassDoc classDoc, Content memberDetailsTree); /** * Get the method documentation tree header. * * @param method the method being documented * @param methodDetailsTree the content tree representing method details * @return content tree for the method documentation header */ ! public Content getMethodDocTreeHeader(MethodDoc method, Content methodDetailsTree); /** * Get the signature for the given method. * * @param method the method being documented * @return content tree for the method signature */ ! public Content getSignature(MethodDoc method); /** * Add the deprecated output for the given method. * * @param method the method being documented * @param methodDocTree content tree to which the deprecated information will be added */ ! public void addDeprecated(MethodDoc method, Content methodDocTree); /** * Add the comments for the given method. * * @param holder the holder type (not erasure) of the method * @param method the method being documented * @param methodDocTree the content tree to which the comments will be added */ ! public void addComments(Type holder, MethodDoc method, Content methodDocTree); /** * Add the tags for the given method. * * @param method the method being documented * @param methodDocTree the content tree to which the tags will be added */ ! public void addTags(MethodDoc method, Content methodDocTree); /** * Get the method details tree. * * @param methodDetailsTree the content tree representing method details --- 47,105 ---- public interface MethodWriter { /** * Get the method details tree header. * ! * @param typeElement the class being documented * @param memberDetailsTree the content tree representing member details * @return content tree for the method details header */ ! public Content getMethodDetailsTreeHeader(TypeElement typeElement, Content memberDetailsTree); /** * Get the method documentation tree header. * * @param method the method being documented * @param methodDetailsTree the content tree representing method details * @return content tree for the method documentation header */ ! public Content getMethodDocTreeHeader(ExecutableElement method, Content methodDetailsTree); /** * Get the signature for the given method. * * @param method the method being documented * @return content tree for the method signature */ ! public Content getSignature(ExecutableElement method); /** * Add the deprecated output for the given method. * * @param method the method being documented * @param methodDocTree content tree to which the deprecated information will be added */ ! public void addDeprecated(ExecutableElement method, Content methodDocTree); /** * Add the comments for the given method. * * @param holder the holder type (not erasure) of the method * @param method the method being documented * @param methodDocTree the content tree to which the comments will be added */ ! public void addComments(TypeMirror holder, ExecutableElement method, Content methodDocTree); /** * Add the tags for the given method. * * @param method the method being documented * @param methodDocTree the content tree to which the tags will be added */ ! public void addTags(ExecutableElement method, Content methodDocTree); /** * Get the method details tree. * * @param methodDetailsTree the content tree representing method details