ConstantsSummaryWriter.java revision 765
0N/A * Copyright (c) 2003, 2008, Oracle and/or its affiliates. All rights reserved. 0N/A * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 0N/A * This code is free software; you can redistribute it and/or modify it 0N/A * under the terms of the GNU General Public License version 2 only, as 0N/A * published by the Free Software Foundation. Oracle designates this 0N/A * particular file as subject to the "Classpath" exception as provided 0N/A * by Oracle in the LICENSE file that accompanied this code. 0N/A * This code is distributed in the hope that it will be useful, but WITHOUT 0N/A * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 0N/A * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 0N/A * version 2 for more details (a copy is included in the LICENSE file that 0N/A * accompanied this code). 0N/A * You should have received a copy of the GNU General Public License version 0N/A * 2 along with this work; if not, write to the Free Software Foundation, 0N/A * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 0N/A * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 0N/A * or visit www.oracle.com if you need additional information or have any 0N/A * The interface for writing constants summary output. 0N/A * This code is not part of an API. 0N/A * It is implementation that is subject to change. 0N/A * Do not use it as an API 0N/A * @author Bhavesh Patel (Modified) 0N/A * Get the header for the constant summary documentation. 0N/A * @return header that needs to be added to the documentation 0N/A * Get the header for the constant content list. 0N/A * @return content header that needs to be added to the documentation 0N/A * Adds the given package name link to the constant content list tree. 0N/A * @param pkg the {@link PackageDoc} to index. 0N/A * @param parsedPackageName the parsed package name. We only Write the 0N/A * first 2 directory levels of the package 0N/A * name. For example, java.lang.ref would be 0N/A * indexed as java.lang.*. 0N/A * @param WriteedPackageHeaders the set of package headers that have already 0N/A * been indexed. We don't want to index 0N/A * something more than once. 0N/A * @param contentListTree the content tree to which the link will be added 0N/A * Get the content list to be added to the documentation tree. 0N/A * @param contentListTree the content that will be added to the list 0N/A * @return content list that will be added to the documentation tree 0N/A * Get the constant summaries for the document. 0N/A * @return constant summaries header to be added to the documentation tree 0N/A * Adds the given package name. 0N/A * @param pkg the {@link PackageDoc} to index. 0N/A * @param parsedPackageName the parsed package name. We only Write the 0N/A * first 2 directory levels of the package 0N/A * name. For example, java.lang.ref would be 0N/A * indexed as java.lang.*. 0N/A * @param summariesTree the documentation tree to which the package name will 0N/A * Get the class summary header for the constants summary. 0N/A * @return the header content for the class constants summary 0N/A * Adds the constant member table to the documentation tree. 0N/A * @param cd the class whose constants are being documented. 0N/A * @param fields the constants being documented. 0N/A * @param classConstantTree the documentation tree to which theconstant member 0N/A * table content will be added 0N/A * Adds the footer for the summary documentation. 0N/A * @param contentTree content tree to which the footer will be added 0N/A * Print the constants summary document. 0N/A * @param contentTree content tree which should be printed