src/jdk.compiler/share/classes/com/sun/source/doctree/ProvidesTree.java
author rkennke
Fri, 12 Oct 2018 16:25:24 +0200
changeset 52107 0c1e44da019c
parent 47216 71c04702a3d5
permissions -rw-r--r--
8212053: A few more missing object equals barriers Reviewed-by: shade, zgu
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
42831
feff6f296019 8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
diff changeset
     1
/*
feff6f296019 8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
diff changeset
     2
 * Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved.
feff6f296019 8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
feff6f296019 8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
diff changeset
     4
 *
feff6f296019 8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
feff6f296019 8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
feff6f296019 8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
feff6f296019 8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
feff6f296019 8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
feff6f296019 8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
diff changeset
    10
 *
feff6f296019 8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
feff6f296019 8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
feff6f296019 8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
feff6f296019 8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
feff6f296019 8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
diff changeset
    15
 * accompanied this code).
feff6f296019 8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
diff changeset
    16
 *
feff6f296019 8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
feff6f296019 8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
feff6f296019 8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
feff6f296019 8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
diff changeset
    20
 *
feff6f296019 8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
feff6f296019 8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
feff6f296019 8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
diff changeset
    23
 * questions.
feff6f296019 8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
diff changeset
    24
 */
feff6f296019 8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
diff changeset
    25
feff6f296019 8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
diff changeset
    26
package com.sun.source.doctree;
feff6f296019 8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
diff changeset
    27
feff6f296019 8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
diff changeset
    28
import java.util.List;
feff6f296019 8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
diff changeset
    29
feff6f296019 8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
diff changeset
    30
/**
feff6f296019 8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
diff changeset
    31
 *
feff6f296019 8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
diff changeset
    32
 * A tree node for a @provides block tag.
feff6f296019 8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
diff changeset
    33
 *
feff6f296019 8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
diff changeset
    34
 * <p>
feff6f296019 8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
diff changeset
    35
 * &#064;provides service-type description
feff6f296019 8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
diff changeset
    36
 *
feff6f296019 8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
diff changeset
    37
 * @since 9
feff6f296019 8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
diff changeset
    38
 */
feff6f296019 8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
diff changeset
    39
public interface ProvidesTree extends BlockTagTree {
feff6f296019 8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
diff changeset
    40
    /**
feff6f296019 8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
diff changeset
    41
     * Returns the name of the service type being documented.
feff6f296019 8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
diff changeset
    42
     * @return the name of the service type
feff6f296019 8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
diff changeset
    43
     */
feff6f296019 8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
diff changeset
    44
    ReferenceTree getServiceType();
feff6f296019 8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
diff changeset
    45
feff6f296019 8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
diff changeset
    46
    /**
feff6f296019 8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
diff changeset
    47
     * Returns a description of the service type being provided by the module.
feff6f296019 8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
diff changeset
    48
     * @return the description
feff6f296019 8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
diff changeset
    49
     */
feff6f296019 8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
diff changeset
    50
    List<? extends DocTree> getDescription();
feff6f296019 8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
diff changeset
    51
}