jdk.javadoc.internal.doclets.package-info Maven / Gradle / Ivy
/*
* Copyright (c) 2003, 2019, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* 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 Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
/**
* Doclets provide the user-selectable back ends for processing the
* documentation comments in Java source code.
*
* Doclets are implementations of the {@link jdk.javadoc.doclet Doclet API}.
*
* Currently, there is only one supported doclet, the
* {@link jdk.javadoc.internal.doclets.formats.html.HtmlDoclet HtmlDoclet},
* for writing API documentation in HTML. Nevertheless, in order to
* separate the high-level code for the general content of each page
* from the low-level details of how to write such content, the code is
* organized in two sections: a format-neutral
* {@link jdk.javadoc.internal.doclets.toolkit toolkit API},
* and a specific {@link jdk.javadoc.internal.doclets.formats format},
* such as {@link jdk.javadoc.internal.doclets.formats.html HTML format}.
*
*
This is NOT part of any supported API.
* If you write code that depends on this, you do so at your own risk.
* This code and its internal interfaces are subject to change or
* deletion without notice.
*/
package jdk.javadoc.internal.doclets;