src/jdk.javadoc/share/classes/jdk/javadoc/doclet/StandardDoclet.java
author jjg
Fri, 23 Mar 2018 17:28:02 -0700
changeset 49415 56a5f899e882
parent 47216 71c04702a3d5
child 49952 a6224ea48b66
permissions -rw-r--r--
8199902: {@docRoot} references need to be updated to reflect new module/package structure Reviewed-by: ksrini
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
10
06bc494ca11e Initial load
duke
parents:
diff changeset
     1
/*
49415
56a5f899e882 8199902: {@docRoot} references need to be updated to reflect new module/package structure
jjg
parents: 47216
diff changeset
     2
 * Copyright (c) 2003, 2018, Oracle and/or its affiliates. All rights reserved.
10
06bc494ca11e Initial load
duke
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
06bc494ca11e Initial load
duke
parents:
diff changeset
     4
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
06bc494ca11e Initial load
duke
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
5520
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 5004
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
10
06bc494ca11e Initial load
duke
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
5520
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 5004
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    10
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
06bc494ca11e Initial load
duke
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
06bc494ca11e Initial load
duke
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
06bc494ca11e Initial load
duke
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
06bc494ca11e Initial load
duke
parents:
diff changeset
    15
 * accompanied this code).
06bc494ca11e Initial load
duke
parents:
diff changeset
    16
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
06bc494ca11e Initial load
duke
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
06bc494ca11e Initial load
duke
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
06bc494ca11e Initial load
duke
parents:
diff changeset
    20
 *
5520
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 5004
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 5004
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 5004
diff changeset
    23
 * questions.
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    24
 */
06bc494ca11e Initial load
duke
parents:
diff changeset
    25
44189
dd311cfb920b 8176331: Simplify new doclet packages
jjg
parents: 40315
diff changeset
    26
package jdk.javadoc.doclet;
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    27
35426
374342e56a56 8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents: 25874
diff changeset
    28
import java.util.Locale;
374342e56a56 8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents: 25874
diff changeset
    29
import java.util.Set;
374342e56a56 8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents: 25874
diff changeset
    30
374342e56a56 8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents: 25874
diff changeset
    31
import javax.lang.model.SourceVersion;
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    32
35426
374342e56a56 8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents: 25874
diff changeset
    33
import jdk.javadoc.internal.doclets.formats.html.HtmlDoclet;
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    34
39179
c04b68e23fa4 8154399: Need replacement for jdk.javadoc/com.sun.tools.doclets.standard.Standard
jjg
parents: 35426
diff changeset
    35
/**
45548
7db465d26194 8180296: Move Javadoc: doclet, taglet specs to specs directory
jjg
parents: 44189
diff changeset
    36
 * This doclet generates HTML-formatted documentation for the specified modules,
7db465d26194 8180296: Move Javadoc: doclet, taglet specs to specs directory
jjg
parents: 44189
diff changeset
    37
 * packages and types.
7db465d26194 8180296: Move Javadoc: doclet, taglet specs to specs directory
jjg
parents: 44189
diff changeset
    38
 *
49415
56a5f899e882 8199902: {@docRoot} references need to be updated to reflect new module/package structure
jjg
parents: 47216
diff changeset
    39
 * @see <a href="{@docRootParent}/specs/doc-comment-spec.html">
45548
7db465d26194 8180296: Move Javadoc: doclet, taglet specs to specs directory
jjg
parents: 44189
diff changeset
    40
 *      Documentation Comment Specification for the Standard Doclet</a>
39179
c04b68e23fa4 8154399: Need replacement for jdk.javadoc/com.sun.tools.doclets.standard.Standard
jjg
parents: 35426
diff changeset
    41
 */
c04b68e23fa4 8154399: Need replacement for jdk.javadoc/com.sun.tools.doclets.standard.Standard
jjg
parents: 35426
diff changeset
    42
public class StandardDoclet implements Doclet {
35426
374342e56a56 8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents: 25874
diff changeset
    43
374342e56a56 8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents: 25874
diff changeset
    44
    private final HtmlDoclet htmlDoclet;
374342e56a56 8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents: 25874
diff changeset
    45
39179
c04b68e23fa4 8154399: Need replacement for jdk.javadoc/com.sun.tools.doclets.standard.Standard
jjg
parents: 35426
diff changeset
    46
    public StandardDoclet() {
35426
374342e56a56 8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents: 25874
diff changeset
    47
        htmlDoclet = new HtmlDoclet();
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    48
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
    49
40315
9e994c77db6a 8160137: HTMLDoclet and AbstractDoclet should implement Doclet
jjg
parents: 39364
diff changeset
    50
    @Override
35426
374342e56a56 8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents: 25874
diff changeset
    51
    public void init(Locale locale, Reporter reporter) {
374342e56a56 8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents: 25874
diff changeset
    52
        htmlDoclet.init(locale, reporter);
374342e56a56 8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents: 25874
diff changeset
    53
    }
374342e56a56 8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents: 25874
diff changeset
    54
40315
9e994c77db6a 8160137: HTMLDoclet and AbstractDoclet should implement Doclet
jjg
parents: 39364
diff changeset
    55
    @Override
35426
374342e56a56 8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents: 25874
diff changeset
    56
    public String getName() {
374342e56a56 8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents: 25874
diff changeset
    57
        return "Standard";
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    58
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
    59
40315
9e994c77db6a 8160137: HTMLDoclet and AbstractDoclet should implement Doclet
jjg
parents: 39364
diff changeset
    60
    @Override
35426
374342e56a56 8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents: 25874
diff changeset
    61
    public Set<Doclet.Option> getSupportedOptions() {
374342e56a56 8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents: 25874
diff changeset
    62
        return htmlDoclet.getSupportedOptions();
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    63
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
    64
40315
9e994c77db6a 8160137: HTMLDoclet and AbstractDoclet should implement Doclet
jjg
parents: 39364
diff changeset
    65
    @Override
35426
374342e56a56 8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents: 25874
diff changeset
    66
    public SourceVersion getSupportedSourceVersion() {
40315
9e994c77db6a 8160137: HTMLDoclet and AbstractDoclet should implement Doclet
jjg
parents: 39364
diff changeset
    67
        return htmlDoclet.getSupportedSourceVersion();
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    68
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
    69
40315
9e994c77db6a 8160137: HTMLDoclet and AbstractDoclet should implement Doclet
jjg
parents: 39364
diff changeset
    70
    @Override
39364
bd6d4a7936b4 8160301: javadoc RootDoclmpl and DocEnv needs to be renamed
ksrini
parents: 39179
diff changeset
    71
    public boolean run(DocletEnvironment docEnv) {
bd6d4a7936b4 8160301: javadoc RootDoclmpl and DocEnv needs to be renamed
ksrini
parents: 39179
diff changeset
    72
        return htmlDoclet.run(docEnv);
35426
374342e56a56 8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents: 25874
diff changeset
    73
    }
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    74
}