jdk8-mips64-public/langtools: src/share/classes/com/sun/tools/doclets/internal/toolkit/AnnotationTypeRequiredMemberWriter.java@25e14ad23cef (annotated)

src/share/classes/com/sun/tools/doclets/internal/toolkit/AnnotationTypeRequiredMemberWriter.java@25e14ad23cef (annotated)

src/share/classes/com/sun/tools/doclets/internal/toolkit/AnnotationTypeRequiredMemberWriter.java

Wed, 10 Oct 2012 16:48:21 -0700

author: jjg
date: Wed, 10 Oct 2012 16:48:21 -0700
changeset 1359: 25e14ad23cef
parent 798: 4868a36f6fd8
child 2035: a2a5ad0853ed
permissions: -rw-r--r--

8000665: fix "internal API" comments on javadoc files
Reviewed-by: darcy

 /*
  * 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
  * particular file as subject to the "Classpath" exception as provided
  * by Oracle in the LICENSE file that accompanied this code.
  *
  * This code is distributed in the hope that it will be useful, but WITHOUT
  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  * version 2 for more details (a copy is included in the LICENSE file that
  * accompanied this code).
  *
  * You should have received a copy of the GNU General Public License version
  * 2 along with this work; if not, write to the Free Software Foundation,
  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  *
  * 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 annotation type required member 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.
  *  This code and its internal interfaces are subject to change or
  *  deletion without notice.</b>
  *
  *
  * @author Jamie Ho
  * @author Bhavesh Patel (Modified)
  * @since 1.5
  */
 public interface AnnotationTypeRequiredMemberWriter {
     /**
      * Add the annotation type details tree header.
      *
      * @param classDoc the annotation type being documented
      * @param memberDetailsTree the content tree representing member details
      */
     public void addAnnotationDetailsTreeHeader(ClassDoc classDoc,
             Content memberDetailsTree);
     /**
      * Get the annotation type documentation tree header.
      *
      * @param member the annotation type being documented
      * @param annotationDetailsTree the content tree representing annotation type details
      * @return content tree for the annotation type documentation header
      */
     public Content getAnnotationDocTreeHeader(MemberDoc member,
             Content annotationDetailsTree);
     /**
      * Get the annotation type details tree.
      *
      * @param annotationDetailsTree the content tree representing annotation type details
      * @return content tree for the annotation type details
      */
     public Content getAnnotationDetails(Content annotationDetailsTree);
     /**
      * Get the annotation type documentation.
      *
      * @param annotationDocTree the content tree representing annotation type documentation
      * @param isLastContent true if the content to be added is the last content
      * @return content tree for the annotation type documentation
      */
     public Content getAnnotationDoc(Content annotationDocTree, boolean isLastContent);
     /**
      * Get the signature for the given member.
      *
      * @param member the member being documented
      * @return content tree for the annotation type signature
      */
     public Content getSignature(MemberDoc member);
     /**
      * Add the deprecated output for the given member.
      *
      * @param member the member being documented
      * @param annotationDocTree content tree to which the deprecated information will be added
      */
     public void addDeprecated(MemberDoc member, Content annotationDocTree);
     /**
      * Add the comments for the given member.
      *
      * @param member the member being documented
      * @param annotationDocTree the content tree to which the comments will be added
      */
     public void addComments(MemberDoc member, Content annotationDocTree);
     /**
      * Add the tags for the given member.
      *
      * @param member the member being documented
      * @param annotationDocTree the content tree to which the tags will be added
      */
     public void addTags(MemberDoc member, Content annotationDocTree);
     /**
      * Close the writer.
      */
     public void close() throws IOException;
 }

Mercurial > jdk8-mips64-public > langtools / annotate

src/share/classes/com/sun/tools/doclets/internal/toolkit/AnnotationTypeRequiredMemberWriter.java@25e14ad23cef (annotated)

src/share/classes/com/sun/tools/doclets/internal/toolkit/AnnotationTypeRequiredMemberWriter.java