1 /*
   2  * Copyright (c) 2003, 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 package jdk.javadoc.doclet;
  27 
  28 import java.util.Locale;
  29 import java.util.Set;
  30 
  31 import javax.lang.model.SourceVersion;
  32 
  33 import jdk.javadoc.internal.doclets.formats.html.HtmlDoclet;
  34 
  35 /**
  36  * This doclet generates HTML-formatted documentation for the specified modules,
  37  * packages and types.
  38  *
  39  * @see <a href="{@docRoot}/../specs/doc-comment-spec.html">
  40  *      Documentation Comment Specification for the Standard Doclet</a>
  41  */
  42 public class StandardDoclet implements Doclet {
  43 
  44     private final HtmlDoclet htmlDoclet;
  45 
  46     public StandardDoclet() {
  47         htmlDoclet = new HtmlDoclet(this);
  48     }
  49 
  50     @Override
  51     public void init(Locale locale, Reporter reporter) {
  52         htmlDoclet.init(locale, reporter);
  53     }
  54 
  55     @Override
  56     public String getName() {
  57         return "Standard";
  58     }
  59 
  60     @Override
  61     public Set<Doclet.Option> getSupportedOptions() {
  62         return htmlDoclet.getSupportedOptions();
  63     }
  64 
  65     @Override
  66     public SourceVersion getSupportedSourceVersion() {
  67         return htmlDoclet.getSupportedSourceVersion();
  68     }
  69 
  70     @Override
  71     public boolean run(DocletEnvironment docEnv) {
  72         return htmlDoclet.run(docEnv);
  73     }
  74 }