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

6786688: Javadoc HTML WCAG 2.0 accessibility issues in standard doclet - Table must have captions and headers
Reviewed-by: jjg

     1 /*

     2  * Copyright 2003 Sun Microsystems, Inc.  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.  Sun designates this

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

     9  * by Sun 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,

    22  * CA 95054 USA or visit www.sun.com if you need additional information or

    23  * have any questions.

    24  */

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

    28 import com.sun.javadoc.*;

    29 import java.io.*;

    31 /**

    32  * The interface for writing package summary output.

    33  *

    34  * This code is not part of an API.

    35  * It is implementation that is subject to change.

    36  * Do not use it as an API

    37  *

    38  * @author Jamie Ho

    39  * @since 1.5

    40  */

    42 public interface PackageSummaryWriter {

    44     /**

    45      * Return the name of the output file.

    46      *

    47      * @return the name of the output file.

    48      */

    49     public abstract String getOutputFileName();

    51     /**

    52      * Write the header for the package summary.

    53      */

    54     public abstract void writeSummaryHeader();

    56     /**

    57      * Write the footer for the package summary.

    58      */

    59     public abstract void writeSummaryFooter();

    61     /**

    62      * Write the table of classes in this package.

    63      *

    64      * @param classes the array of classes to document.

    65      * @param label the label for this table.

    66      */

    67     public abstract void writeClassesSummary(ClassDoc[] classes, String label, String tableSummary, String[] tableHeader);

    69     /**

    70      * Write the header for the summary.

    71      *

    72      * @param heading Package name.

    73      */

    74     public abstract void writePackageHeader(String heading);

    76     /**

    77      * Print the package description from the "packages.html" file.

    78      */

    79     public abstract void writePackageDescription();

    81     /**

    82      * Print the tag information from the "packages.html" file.

    83      */

    84     public abstract void writePackageTags();

    86     /**

    87      * Write the footer for the summary.

    88      *

    89      */

    90     public abstract void writePackageFooter();

    92     /**

    93      * Close the writer.

    94      */

    95     public abstract void close() throws IOException;

    97 }

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