910N/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 * abstract base class of all Doc classes. Doc item's are representations 0N/A * of java language constructs (class, package, method,...) which have 0N/A * comments and have been processed by this run of javadoc. All Doc items 0N/A * are unique, that is, they are == comparable. 0N/A * @author Robert Field 0N/A * @author Atul M Dambalkar 0N/A * @author Neal Gafter (rewrite) 0N/A protected final DocEnv env;
//### Rename this everywhere to 'docenv' ? 0N/A * The complex comment object, lazily initialized. 0N/A * The cached sort key, to take care of Natural Language Text sorting. 0N/A * Raw documentation string. 0N/A * Cached first sentence. 0N/A * Cached inline tags. 0N/A * So subclasses have the option to do lazy initialization of 0N/A * "documentation" string. 0N/A * For lazy initialization of comment. 0N/A * Return the text of the comment for this doc item. 0N/A * TagImpls have been removed. 0N/A * Return all tags in this Doc item. 0N/A * @return an array of TagImpl containing all tags on this Doc item. 0N/A * Return tags of the specified kind in this Doc item. 0N/A * @param tagname name of the tag kind to search for. 0N/A * @return an array of TagImpl containing all tags whose 'kind()' 0N/A * matches 'tagname'. 0N/A * Return the see also tags in this Doc item. 0N/A * @return an array of SeeTag containing all @see tags. 0N/A //Parse all sentences first to avoid duplicate warnings. 0N/A * Utility for subclasses which read HTML documentation files. 910N/A ?
"javadoc.End_body_missing_from_html_file" 910N/A :
"javadoc.Body_missing_from_html_file";
0N/A * Return the full unprocessed text of the comment. Tags 0N/A * are included as text. Used mainly for store and retrieve 0N/A * operations like internalization. 0N/A * Set the full unprocessed text of the comment. Tags 0N/A * are included as text. Used mainly for store and retrieve 0N/A * operations like internalization. 0N/A * return a key for sorting. 0N/A * Generate a key for sorting. 0N/A * Default is name(). 0N/A // System.out.println("COLLATION KEY FOR " + this + " is \"" + k + "\""); 0N/A * Returns a string representation of this Doc item. 0N/A * Returns the name of this Doc item. 0N/A * Returns the qualified name of this Doc item. 0N/A * Compares this Object with the specified Object for order. Returns a 0N/A * negative integer, zero, or a positive integer as this Object is less 0N/A * than, equal to, or greater than the given Object. 0N/A * Included so that Doc item are java.lang.Comparable. 0N/A * @param o the <code>Object</code> to be compared. 0N/A * @return a negative integer, zero, or a positive integer as this Object 0N/A * is less than, equal to, or greater than the given Object. 0N/A * @exception ClassCastException the specified Object's type prevents it 0N/A * from being compared to this Object. 0N/A // System.out.println("COMPARE \"" + this + "\" to \"" + obj + "\" = " + key().compareTo(((DocImpl)obj).key())); 0N/A * Is this Doc item a field? False until overridden. 0N/A * @return true if it represents a field 0N/A * Is this Doc item an enum constant? False until overridden. 0N/A * @return true if it represents an enum constant 0N/A * Is this Doc item a constructor? False until overridden. 0N/A * @return true if it represents a constructor 0N/A * Is this Doc item a method (but not a constructor or annotation 0N/A * False until overridden. 0N/A * @return true if it represents a method 0N/A * Is this Doc item an annotation type element? 0N/A * False until overridden. 0N/A * @return true if it represents an annotation type element 0N/A * Is this Doc item a interface (but not an annotation type)? 0N/A * False until overridden. 0N/A * @return true if it represents a interface 0N/A * Is this Doc item a exception class? False until overridden. 0N/A * @return true if it represents a exception 0N/A * Is this Doc item a error class? False until overridden. 0N/A * @return true if it represents a error 0N/A * Is this Doc item an enum type? False until overridden. 0N/A * @return true if it represents an enum type 0N/A * Is this Doc item an annotation type? False until overridden. 0N/A * @return true if it represents an annotation type 0N/A * Is this Doc item an ordinary class (i.e. not an interface, 0N/A * annotation type, enumeration, exception, or error)? 0N/A * False until overridden. 0N/A * @return true if it represents an ordinary class 0N/A * Is this Doc item a class 0N/A * (and not an interface or annotation type)? 0N/A * This includes ordinary classes, enums, errors and exceptions. 0N/A * False until overridden. 0N/A * @return true if it represents a class 0N/A * return true if this Doc is include in the active set. 0N/A * Return the source position of the entity, or null if 0N/A * no position is available.