ConstantsSummaryWriter.java revision 116
286N/A * Copyright 2003-2008 Sun Microsystems, Inc. All Rights Reserved. 286N/A * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 286N/A * This code is free software; you can redistribute it and/or modify it 286N/A * under the terms of the GNU General Public License version 2 only, as 286N/A * published by the Free Software Foundation. Sun designates this 286N/A * particular file as subject to the "Classpath" exception as provided 286N/A * by Sun in the LICENSE file that accompanied this code. 286N/A * This code is distributed in the hope that it will be useful, but WITHOUT 286N/A * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 286N/A * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 286N/A * 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, * CA 95054 USA or visit www.sun.com if you need additional information or * The interface for writing constants summary output. * This code is not part of an API. * It is implementation that is subject to change. * Do not use it as an API * Write the header for the summary. * Write the footer for the summary. * Write the header for the index. * Write the footer for the index. * Add the given package name to the index. * @param pkg the {@link PackageDoc} to index. * @param parsedPackageName the parsed package name. We only Write the * first 2 directory levels of the package * name. For example, java.lang.ref would be * indexed as java.lang.*. * @param WriteedPackageHeaders the set of package headers that have already * been indexed. We don't want to index * something more than once. * Write the given package name. * @param pkg the {@link PackageDoc} to index. * @param parsedPackageName the parsed package name. We only Write the * first 2 directory levels of the package * name. For example, java.lang.ref would be * indexed as java.lang.*. * Write the heading for the current table of constants for a given class. * @param cd the class whose constants are being documented. * Document the given constants. * @param cd the class whose constants are being documented. * @param fields the constants being documented. * Document the given constants. * @param cd the class whose constants are being documented.