Path: blob/master/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/package-info.java
41161 views
/*1* Copyright (c) 2003, 2019, Oracle and/or its affiliates. All rights reserved.2* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.3*4* This code is free software; you can redistribute it and/or modify it5* under the terms of the GNU General Public License version 2 only, as6* published by the Free Software Foundation. Oracle designates this7* particular file as subject to the "Classpath" exception as provided8* by Oracle in the LICENSE file that accompanied this code.9*10* This code is distributed in the hope that it will be useful, but WITHOUT11* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or12* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License13* version 2 for more details (a copy is included in the LICENSE file that14* accompanied this code).15*16* You should have received a copy of the GNU General Public License version17* 2 along with this work; if not, write to the Free Software Foundation,18* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.19*20* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA21* or visit www.oracle.com if you need additional information or have any22* questions.23*/2425/**26* Doclets provide the user-selectable back ends for processing the27* documentation comments in Java source code.28*29* <p>Doclets are implementations of the {@link jdk.javadoc.doclet Doclet API}.</p>30*31* <p>Currently, there is only one supported doclet, the32* {@link jdk.javadoc.internal.doclets.formats.html.HtmlDoclet HtmlDoclet},33* for writing API documentation in HTML. Nevertheless, in order to34* separate the high-level code for the general content of each page35* from the low-level details of how to write such content, the code is36* organized in two sections: a format-neutral37* {@link jdk.javadoc.internal.doclets.toolkit toolkit API},38* and a specific {@link jdk.javadoc.internal.doclets.formats format},39* such as {@link jdk.javadoc.internal.doclets.formats.html HTML format}.40*41* <p><b>This is NOT part of any supported API.42* If you write code that depends on this, you do so at your own risk.43* This code and its internal interfaces are subject to change or44* deletion without notice.</b>45*/4647package jdk.javadoc.internal.doclets;484950