jdk8-mips64-public/langtools: src/share/classes/com/sun/tools/doclets/internal/toolkit/AnnotationTypeFieldWriter.java@a2a5ad0853ed

8015249: javadoc fails to document static final fields in annotation types
Reviewed-by: jjg

     1 /*

     2  * Copyright (c) 2013, Oracle and/or its affiliates. All rights reserved.

     3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

     4  *

     5  * This code is free software; you can redistribute it and/or modify it

     6  * under the terms of the GNU General Public License version 2 only, as

     7  * published by the Free Software Foundation.  Oracle designates this

     8  * particular file as subject to the "Classpath" exception as provided

     9  * by Oracle in the LICENSE file that accompanied this code.

    10  *

    11  * This code is distributed in the hope that it will be useful, but WITHOUT

    12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

    13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

    14  * version 2 for more details (a copy is included in the LICENSE file that

    15  * accompanied this code).

    16  *

    17  * You should have received a copy of the GNU General Public License version

    18  * 2 along with this work; if not, write to the Free Software Foundation,

    19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

    20  *

    21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

    22  * or visit www.oracle.com if you need additional information or have any

    23  * questions.

    24  */

    26 package com.sun.tools.doclets.internal.toolkit;

    28 import java.io.*;

    29 import com.sun.javadoc.*;

    31 /**

    32  * The interface for writing annotation type field output.

    33  *

    34  *  <p><b>This is NOT part of any supported API.

    35  *  If you write code that depends on this, you do so at your own risk.

    36  *  This code and its internal interfaces are subject to change or

    37  *  deletion without notice.</b>

    38  *

    39  *

    40  * @author Bhavesh Patel

    41  * @since 1.8

    42  */

    44 public interface AnnotationTypeFieldWriter {

    46     /**

    47      * Add the annotation type member tree header.

    48      *

    49      * @return content tree for the member tree header

    50      */

    51     public Content getMemberTreeHeader();

    53     /**

    54      * Add the annotation type field details marker.

    55      *

    56      * @param memberDetails the content tree representing field details marker

    57      */

    58     public void addAnnotationFieldDetailsMarker(Content memberDetails);

    60     /**

    61      * Add the annotation type details tree header.

    62      *

    63      * @param classDoc the annotation type being documented

    64      * @param memberDetailsTree the content tree representing member details

    65      */

    66     public void addAnnotationDetailsTreeHeader(ClassDoc classDoc,

    67             Content memberDetailsTree);

    69     /**

    70      * Get the annotation type documentation tree header.

    71      *

    72      * @param member the annotation type being documented

    73      * @param annotationDetailsTree the content tree representing annotation type details

    74      * @return content tree for the annotation type documentation header

    75      */

    76     public Content getAnnotationDocTreeHeader(MemberDoc member,

    77             Content annotationDetailsTree);

    79     /**

    80      * Get the annotation type details tree.

    81      *

    82      * @param annotationDetailsTree the content tree representing annotation type details

    83      * @return content tree for the annotation type details

    84      */

    85     public Content getAnnotationDetails(Content annotationDetailsTree);

    87     /**

    88      * Get the annotation type documentation.

    89      *

    90      * @param annotationDocTree the content tree representing annotation type documentation

    91      * @param isLastContent true if the content to be added is the last content

    92      * @return content tree for the annotation type documentation

    93      */

    94     public Content getAnnotationDoc(Content annotationDocTree, boolean isLastContent);

    96     /**

    97      * Get the signature for the given member.

    98      *

    99      * @param member the member being documented

   100      * @return content tree for the annotation type signature

   101      */

   102     public Content getSignature(MemberDoc member);

   104     /**

   105      * Add the deprecated output for the given member.

   106      *

   107      * @param member the member being documented

   108      * @param annotationDocTree content tree to which the deprecated information will be added

   109      */

   110     public void addDeprecated(MemberDoc member, Content annotationDocTree);

   112     /**

   113      * Add the comments for the given member.

   114      *

   115      * @param member the member being documented

   116      * @param annotationDocTree the content tree to which the comments will be added

   117      */

   118     public void addComments(MemberDoc member, Content annotationDocTree);

   120     /**

   121      * Add the tags for the given member.

   122      *

   123      * @param member the member being documented

   124      * @param annotationDocTree the content tree to which the tags will be added

   125      */

   126     public void addTags(MemberDoc member, Content annotationDocTree);

   128     /**

   129      * Close the writer.

   130      */

   131     public void close() throws IOException;

   132 }

Mercurial > jdk8-mips64-public > langtools / file revision