911N/A * Copyright (c) 1997, 2011, 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 553N/A * published by the Free Software Foundation. Oracle designates this 0N/A * particular file as subject to the "Classpath" exception as provided 553N/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. 553N/A * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 553N/A * or visit www.oracle.com if you need additional information or have any 0N/A * This class holds the information from one run of javadoc. 0N/A * Particularly the packages, classes and options specified 0N/A * @author Robert Field 0N/A * @author Atul M Dambalkar 0N/A * @author Neal Gafter (rewrite) 0N/A * list of classes specified on the command line. 0N/A * list of packages specified on the command line. 0N/A * a collection of all options. 0N/A * Constructor used when reading source files. 0N/A * @param env the documentation environment, state for this javadoc run 0N/A * @param classes list of classes specified on the commandline 0N/A * @param packages list of package names specified on the commandline 0N/A * @param options list of options 0N/A * Constructor used when reading class files. 0N/A * @param env the documentation environment, state for this javadoc run 0N/A * @param classes list of class names specified on the commandline 0N/A * @param options list of options 0N/A * Initialize classes information. Those classes are input from 0N/A * @param env the compilation environment 0N/A * @param classes a list of ClassDeclaration 0N/A //### Do we want modifier check here? 0N/A }
//else System.out.println(" (classdoc is null)");//DEBUG 0N/A }
//else System.out.println(" (env.shouldDocument() returned false)");//DEBUG 0N/A * Initialize packages information. 0N/A * @param env the compilation environment 0N/A * @param packages a list of package names (String) 0N/A * Command line options. 0N/A * For example, given: 0N/A * javadoc -foo this that -bar other ... 0N/A * This method will return: 0N/A * options()[0][0] = "-foo" 0N/A * options()[0][1] = "this" 0N/A * options()[0][2] = "that" 0N/A * options()[1][0] = "-bar" 0N/A * options()[1][1] = "other" 0N/A * @return an array of arrays of String. 0N/A * Packages specified on the command line. 0N/A * Classes and interfaces specified on the command line. 0N/A * Return all classes and interfaces (including those inside 0N/A * packages) to be documented. 0N/A * @param qualifiedName qualified class name 0N/A * (i.e. includes package name). 0N/A * @return a ClassDocImpl holding the specified class, null if 0N/A * this class is not referenced. 0N/A * Return a PackageDoc for the specified package name 0N/A * @param name package name 0N/A * @return a PackageDoc holding the specified package, null if 0N/A * this package is not referenced. 0N/A * Return the name of this Doc item. 0N/A * @return the string <code>"*RootDocImpl*"</code>. 0N/A return "*RootDocImpl*";
0N/A * Return the name of this Doc item. 0N/A * @return the string <code>"*RootDocImpl*"</code>. 0N/A return "*RootDocImpl*";
0N/A * Return true if this Doc is include in the active set. 0N/A * RootDocImpl isn't even a program entity so it is always false. 0N/A * Print error message, increment error count. 0N/A * @param msg message to print 0N/A * Print error message, increment error count. 0N/A * @param msg message to print 0N/A * Print warning message, increment warning count. 0N/A * @param msg message to print 0N/A * Print warning message, increment warning count. 0N/A * @param msg message to print 0N/A * @param msg message to print 0N/A * @param msg message to print 0N/A * Return the path of the overview file and null if it does not exist. 0N/A * @return the path of the overview file and null if it does not exist. 0N/A * Do lazy initialization of "documentation" string. 0N/A // no doc file to be had 0N/A * Return the source position of the entity, or null if 0N/A * no position is available. 190N/A * Return the locale provided by the user or the default locale value.