1 /*
2  * Copyright (c) 2018, Oracle and/or its affiliates. All rights reserved.
3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4  *
5  * This code is free software; you can redistribute it and/or modify it
6  * under the terms of the GNU General Public License version 2 only, as
7  * published by the Free Software Foundation.  Oracle designates this
8  * particular file as subject to the "Classpath" exception as provided
9  * by Oracle in the LICENSE file that accompanied this code.
10  *
11  * This code is distributed in the hope that it will be useful, but WITHOUT
12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14  * version 2 for more details (a copy is included in the LICENSE file that
15  * accompanied this code).
16  *
17  * You should have received a copy of the GNU General Public License version
18  * 2 along with this work; if not, write to the Free Software Foundation,
19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20  *
21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22  * or visit www.oracle.com if you need additional information or have any
23  * questions.
24  */
25 
26 /**
27  *  Provides the front end for the javadoc tool.
28  *
29  *  <p>The main entry points are in {@link jdk.javadoc.internal.tool.Main}
30  *  which calls the (poorly-named) {@link jdk.javadoc.internal.tool.Start}
31  *  which provides the overall functionality of the tool.
32  *
33  *  <p>The classes provide a framework for processing command-line options
34  *  and determining the set of elements (modules, packages, types and members)
35  *  to be documented.
36  *
37  *  <p>The classes also provide the means to use the javac front end to read
38  *  source files, including the documentation comments.
39  *
40  *  <p>Finally, once the appropriate files have been read, the classes invoke
41  *  the selected doclet to process those files, typically to generate API
42  *  documentation.
43  *
44  *  <p><b>This is NOT part of any supported API.
45  *  If you write code that depends on this, you do so at your own risk.
46  *  This code and its internal interfaces are subject to change or
47  *  deletion without notice.</b>
48  */
49 package jdk.javadoc.internal.tool;
50