• Home
• org.frgaal
• compiler
• 16.0.0
• source code
• package-info.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

jdk.javadoc.doclet.package-info Maven / Gradle / Ivy

/*
 * Copyright (c) 2015, 2017, 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.
 */

/**
 * The Doclet API provides an environment which, in conjunction with
 * the Language Model API and Compiler Tree API, allows clients
 * to inspect the source-level structures of programs and
 * libraries, including API comments embedded in the source.
 *
 * 

 * The {@link StandardDoclet standard doclet} can be used to
 * generate HTML-formatted documentation. It supports user-defined
 * {@link Taglet taglets}, which can be used to generate customized
 * output for user-defined tags in documentation comments.
 *
 * 

 * Note: The declarations in this package supersede those
 * in the older package {@code com.sun.javadoc}. For details on the
 * mapping of old types to new types, see the
 * Migration Guide.
 * 
 *
 * 

 * Doclets are invoked by javadoc and this API can be used to write out
 * program information to files.  For example, the standard doclet is
 * invoked by default, to generate HTML documentation.
 * 


 * The invocation is defined by the interface {@link jdk.javadoc.doclet.Doclet}
 * -- the {@link jdk.javadoc.doclet.Doclet#run(DocletEnvironment) run} interface
 * method, defines the entry point.
 * 
 *    public boolean run(DocletEnvironment environment)
 * 
 * The {@link jdk.javadoc.doclet.DocletEnvironment} instance holds the
 * environment that the doclet will be initialized with. From this environment
 * all other information can be extracted, in the form of
 * {@link javax.lang.model.element.Element elements}. One can further use the APIs and utilities
 * described by {@link javax.lang.model Language Model API} to query Elements and Types.
 * 

 *
 * 
 * 
Terminology
 *
 * 

 *   
Selected
 *     
An element is considered to be selected, if the
 *         selection controls allow it
 *         to be documented. (Note that synthetic elements are never
 *         selected.)
 *    
 *
 *   
Specified
 *   
The set of elements specified by the user are considered to be specified
 *       elements. Specified elements provide the starting points
 *       for determining the included elements to be documented.
 *   
 *
 *   
Included
 *   
An element is considered to be included, if it is
 *       specified if it contains a specified element,
 *       or it is enclosed in a specified element, and is selected.
 *       Included elements will be documented.
 *   
 *
 * 
 * 

 * 
 * 
Options
 * Javadoc selection control can be specified with these options
 * as follows:
 * 

 *   
{@code --show-members:value} and {@code --show-types:value} can
 *       be used to filter the members, with the following values:
 *   

 *     
 public    -- considers only public elements
 *     
 protected -- considers public and protected elements
 *     
 package   -- considers public, protected and package private elements
 *     
 private   -- considers all elements
 *   
 *
 *   
{@code --show-packages:value} "exported" or "all" can be used
 *       to consider only exported packages or all packages within a module.
 *
 *   
{@code --show-module-contents:value} can be used to specify the level at
 *       module declarations could be documented. A value of "api" indicates API
 *       level documentation, and "all" indicates detailed documentation.
 * 
 * The following options can be used to specify the elements to be documented:
 * 

 *   
{@code --module} documents the specified modules.
 *
 *   
{@code --expand-requires:value} expand the set of modules to be documented
 *        by including some or all of the modules dependencies. The value may be
 *        one of:
 *   

 *     
 transitive -- each module specified explicitly on the command line is
 *          expanded to include the closure of its transitive dependencies
 *     
 all    -- each module specified explicitly on the command line
 *          is expanded to include the closure of its transitive dependencies,
 *          and also all of its direct dependencies
 *   
 *   By default, only the specified modules will be considered, without expansion
 *   of the module dependencies.
 *
 *   
{@code packagenames} can be used to specify packages.
 *   
{@code -subpackages} can be used to recursively load packages.
 *   
{@code -exclude} can be used exclude package directories.
 *   
{@code sourcefilenames} can be used to specify source file names.
 * 
 * 

 * 
 * 
Interactions with older options.
 *
 * The new {@code --show-*} options provide a more detailed replacement
 * for the older options {@code -public}, {@code -protected}, {@code -package}, {@code -private}.
 * Alternatively, the older options can continue to be used as shorter
 * forms for combinations of the new options, as described below:
 * 
 *   
 *   
 *       
 *   
 *       
 * 
Short form options mapping
   

 *                      Older option
 *              

 *                      Equivalent to these values with the new option
 *       
   
{@code --show-members}
 *              
{@code --show-types}
 *              
{@code --show-packages}
 *              
{@code --show-module-contents}
 *   
   
{@code -public}
 *              
public
 *              
public
 *              
exported
 *              
api
 *       
   
{@code -protected}
 *              
protected
 *              
protected
 *              
exported
 *              
api
 *       
   
{@code -package}
 *              
package
 *              
package
 *              
all
 *              
all
 *       
   
{@code -private}
 *              
private
 *              
private
 *              
all
 *              
all
 *   
 * 

 * 
 * A qualified element name is one that has its package
 * name prepended to it, such as {@code java.lang.String}.  A non-qualified
 * name has no package name, such as {@code String}.
 * 

 *
 * 
 * 
Example
 *
 * The following is an example doclet that displays information of a class
 * and its members, supporting an option.
 * 
 * // note imports deleted for clarity
 * public class Example implements Doclet {
 *    Reporter reporter;
 *    @Override
 *    public void init(Locale locale, Reporter reporter) {
 *        reporter.print(Kind.NOTE, "Doclet using locale: " + locale);
 *        this.reporter = reporter;
 *    }
 *
 *    public void printElement(DocTrees trees, Element e) {
 *        DocCommentTree docCommentTree = trees.getDocCommentTree(e);
 *        if (docCommentTree != null) {
 *            System.out.println("Element (" + e.getKind() + ": "
 *                    + e + ") has the following comments:");
 *            System.out.println("Entire body: " + docCommentTree.getFullBody());
 *            System.out.println("Block tags: " + docCommentTree.getBlockTags());
 *        }
 *    }
 *
 *    @Override
 *    public boolean run(DocletEnvironment docEnv) {
 *        reporter.print(Kind.NOTE, "overviewfile: " + overviewfile);
 *        // get the DocTrees utility class to access document comments
 *        DocTrees docTrees = docEnv.getDocTrees();
 *
 *        // location of an element in the same directory as overview.html
 *        try {
 *            Element e = ElementFilter.typesIn(docEnv.getSpecifiedElements()).iterator().next();
 *            DocCommentTree docCommentTree
 *                    = docTrees.getDocCommentTree(e, overviewfile);
 *            if (docCommentTree != null) {
 *                System.out.println("Overview html: " + docCommentTree.getFullBody());
 *            }
 *        } catch (IOException missing) {
 *            reporter.print(Kind.ERROR, "No overview.html found.");
 *        }
 *
 *        for (TypeElement t : ElementFilter.typesIn(docEnv.getIncludedElements())) {
 *            System.out.println(t.getKind() + ":" + t);
 *            for (Element e : t.getEnclosedElements()) {
 *                printElement(docTrees, e);
 *            }
 *        }
 *        return true;
 *    }
 *
 *    @Override
 *    public String getName() {
 *        return "Example";
 *    }
 *
 *    private String overviewfile;
 *
 *    @Override
 *    public Set<? extends Option> getSupportedOptions() {
 *        Option[] options = {
 *            new Option() {
 *                private final List<String> someOption = Arrays.asList(
 *                        "-overviewfile",
 *                        "--overview-file",
 *                        "-o"
 *                );
 *
 *                @Override
 *                public int getArgumentCount() {
 *                    return 1;
 *                }
 *
 *                @Override
 *                public String getDescription() {
 *                    return "an option with aliases";
 *                }
 *
 *                @Override
 *                public Option.Kind getKind() {
 *                    return Option.Kind.STANDARD;
 *                }
 *
 *                @Override
 *                public List<String> getNames() {
 *                    return someOption;
 *                }
 *
 *                @Override
 *                public String getParameters() {
 *                    return "file";
 *                }
 *
 *                @Override
 *                public boolean process(String opt, List<String> arguments) {
 *                    overviewfile = arguments.get(0);
 *                    return true;
 *                }
 *            }
 *        };
 *        return new HashSet<>(Arrays.asList(options));
 *    }
 *
 *    @Override
 *    public SourceVersion getSupportedSourceVersion() {
 *        // support the latest release
 *        return SourceVersion.latest();
 *    }
 * }
 * 
 * 

 * This doclet can be invoked with a command line, such as:
 * 
 *     javadoc -doclet Example \
 *       -overviewfile overview.html \
 *       -sourcepath source-location \
 *       source-location/Example.java
 * 
 *
 * 
Migration Guide
 *
 * 
Many of the types in the old {@code com.sun.javadoc} API do not have equivalents in this
 * package. Instead, types in the {@code javax.lang.model} and {@code com.sun.source} APIs
 * are used instead.
 *
 * 
The following table gives a guide to the mapping from old types to their replacements.
 * In some cases, there is no direct equivalent.
 *
 * 
 *   
 *   
 *     
 *   
 *     
 * 
Guide for mapping old types to new types
Old Type
New Type
 *   
{@code AnnotatedType}            
{@link javax.lang.model.type.TypeMirror javax.lang.model.type.TypeMirror}
 *     
{@code AnnotationDesc}           
{@link javax.lang.model.element.AnnotationMirror javax.lang.model.element.AnnotationMirror}
 *     
{@code AnnotationDesc.ElementValuePair}
{@link javax.lang.model.element.AnnotationValue javax.lang.model.element.AnnotationValue}
 *     
{@code AnnotationTypeDoc}        
{@link javax.lang.model.element.TypeElement javax.lang.model.element.TypeElement}
 *     
{@code AnnotationTypeElementDoc} 
{@link javax.lang.model.element.ExecutableElement javax.lang.model.element.ExecutableElement}
 *     
{@code AnnotationValue}          
{@link javax.lang.model.element.AnnotationValue javax.lang.model.element.AnnotationValue}
 *     
{@code ClassDoc}                 
{@link javax.lang.model.element.TypeElement javax.lang.model.element.TypeElement}
 *     
{@code ConstructorDoc}           
{@link javax.lang.model.element.ExecutableElement javax.lang.model.element.ExecutableElement}
 *     
{@code Doc}                      
{@link javax.lang.model.element.Element javax.lang.model.element.Element}
 *     
{@code DocErrorReporter}         
{@link jdk.javadoc.doclet.Reporter jdk.javadoc.doclet.Reporter}
 *     
{@code Doclet}                   
{@link jdk.javadoc.doclet.Doclet jdk.javadoc.doclet.Doclet}
 *     
{@code ExecutableMemberDoc}      
{@link javax.lang.model.element.ExecutableElement javax.lang.model.element.ExecutableElement}
 *     
{@code FieldDoc}                 
{@link javax.lang.model.element.VariableElement javax.lang.model.element.VariableElement}
 *     
{@code LanguageVersion}          
{@link javax.lang.model.SourceVersion javax.lang.model.SourceVersion}
 *     
{@code MemberDoc}                
{@link javax.lang.model.element.Element javax.lang.model.element.Element}
 *     
{@code MethodDoc}                
{@link javax.lang.model.element.ExecutableElement javax.lang.model.element.ExecutableElement}
 *     
{@code PackageDoc}               
{@link javax.lang.model.element.PackageElement javax.lang.model.element.PackageElement}
 *     
{@code Parameter}                
{@link javax.lang.model.element.VariableElement javax.lang.model.element.VariableElement}
 *     
{@code ParameterizedType}        
{@link javax.lang.model.type.DeclaredType javax.lang.model.type.DeclaredType}
 *     
{@code ParamTag}                 
{@link com.sun.source.doctree.ParamTree com.sun.source.doctree.ParamTree}
 *     
{@code ProgramElementDoc}        
{@link javax.lang.model.element.Element javax.lang.model.element.Element}
 *     
{@code RootDoc}                  
{@link jdk.javadoc.doclet.DocletEnvironment jdk.javadoc.doclet.DocletEnvironment}
 *     
{@code SeeTag}                   
{@link com.sun.source.doctree.LinkTree com.sun.source.doctree.LinkTree}

 *                                                              {@link com.sun.source.doctree.SeeTree com.sun.source.doctree.SeeTree}
 *     
{@code SerialFieldTag}           
{@link com.sun.source.doctree.SerialFieldTree com.sun.source.doctree.SerialFieldTree}
 *     
{@code SourcePosition}           
{@link com.sun.source.util.SourcePositions com.sun.source.util.SourcePositions}
 *     
{@code Tag}                      
{@link com.sun.source.doctree.DocTree com.sun.source.doctree.DocTree}
 *     
{@code ThrowsTag}                
{@link com.sun.source.doctree.ThrowsTree com.sun.source.doctree.ThrowsTree}
 *     
{@code Type}                     
{@link javax.lang.model.type.TypeMirror javax.lang.model.type.TypeMirror}
 *     
{@code TypeVariable}             
{@link javax.lang.model.type.TypeVariable javax.lang.model.type.TypeVariable}
 *     
{@code WildcardType}             
{@link javax.lang.model.type.WildcardType javax.lang.model.type.WildcardType}
 *   
 *
 * @see jdk.javadoc.doclet.Doclet
 * @see jdk.javadoc.doclet.DocletEnvironment
 * @since 9
*/

package jdk.javadoc.doclet;