jdk8-mips64-public/langtools: src/share/classes/com/sun/tools/doclets/internal/toolkit/AbstractDoclet.java@78962d89f283 (annotated)

src/share/classes/com/sun/tools/doclets/internal/toolkit/AbstractDoclet.java@78962d89f283 (annotated)

src/share/classes/com/sun/tools/doclets/internal/toolkit/AbstractDoclet.java

Tue, 23 Oct 2012 13:20:37 -0700

author: jjg
date: Tue, 23 Oct 2012 13:20:37 -0700
changeset 1372: 78962d89f283
parent 1359: 25e14ad23cef
child 1383: b980e8e6aabf
permissions: -rw-r--r--

8000741: refactor javadoc to use abstraction to handle relative paths
Reviewed-by: darcy

 /*
  * Copyright (c) 2003, 2012, 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.
  */
 package com.sun.tools.doclets.internal.toolkit;
 import com.sun.javadoc.*;
 import com.sun.tools.doclets.internal.toolkit.builders.*;
 import com.sun.tools.doclets.internal.toolkit.util.*;
 import java.io.File;
 import java.util.StringTokenizer;
 /**
  * An abstract implementation of a Doclet.
  *
  *  <p><b>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.</b>
  *
  * @author Jamie Ho
  */
 public abstract class AbstractDoclet {
     /**
      * The global configuration information for this run.
      */
     public Configuration configuration;
     /**
      * The only doclet that may use this toolkit is {@value}
      */
     private static final String TOOLKIT_DOCLET_NAME = new
         com.sun.tools.doclets.formats.html.HtmlDoclet().getClass().getName();
     /**
      * Verify that the only doclet that is using this toolkit is
      * {@value #TOOLKIT_DOCLET_NAME}.
      */
     private boolean isValidDoclet(AbstractDoclet doclet) {
         if (! doclet.getClass().getName().equals(TOOLKIT_DOCLET_NAME)) {
             configuration.message.error("doclet.Toolkit_Usage_Violation",
                 TOOLKIT_DOCLET_NAME);
             return false;
         }
         return true;
     }
     /**
      * The method that starts the execution of the doclet.
      *
      * @param doclet the doclet to start the execution for.
      * @param root   the {@link RootDoc} that points to the source to document.
      * @return true if the doclet executed without error.  False otherwise.
      */
     public boolean start(AbstractDoclet doclet, RootDoc root) {
         configuration = configuration();
         configuration.root = root;
         if (! isValidDoclet(doclet)) {
             return false;
         }
         try {
             doclet.startGeneration(root);
         } catch (Exception exc) {
             exc.printStackTrace();
             return false;
         }
         return true;
     }
     /**
      * Indicate that this doclet supports the 1.5 language features.
      * @return JAVA_1_5, indicating that the new features are supported.
      */
     public static LanguageVersion languageVersion() {
         return LanguageVersion.JAVA_1_5;
     }
     /**
      * Create the configuration instance and returns it.
      * @return the configuration of the doclet.
      */
     public abstract Configuration configuration();
     /**
      * Start the generation of files. Call generate methods in the individual
      * writers, which will in turn genrate the documentation files. Call the
      * TreeWriter generation first to ensure the Class Hierarchy is built
      * first and then can be used in the later generation.
      *
      * @see com.sun.javadoc.RootDoc
      */
     private void startGeneration(RootDoc root) throws Exception {
         if (root.classes().length == 0) {
             configuration.message.
                 error("doclet.No_Public_Classes_To_Document");
             return;
         }
         configuration.setOptions();
         configuration.getDocletSpecificMsg().notice("doclet.build_version",
             configuration.getDocletSpecificBuildDate());
         ClassTree classtree = new ClassTree(configuration, configuration.nodeprecated);
         generateClassFiles(root, classtree);
         if (configuration.sourcepath != null && configuration.sourcepath.length() > 0) {
             StringTokenizer pathTokens = new StringTokenizer(configuration.sourcepath,
                 String.valueOf(File.pathSeparatorChar));
             boolean first = true;
             while(pathTokens.hasMoreTokens()){
                 Util.copyDocFiles(configuration,
                     new File(pathTokens.nextToken()),
                     DocPaths.DOC_FILES, first);
                 first = false;
             }
         }
         PackageListWriter.generate(configuration);
         generatePackageFiles(classtree);
         generateOtherFiles(root, classtree);
         configuration.tagletManager.printReport();
     }
     /**
      * Generate additional documentation that is added to the API documentation.
      *
      * @param root      the RootDoc of source to document.
      * @param classtree the data structure representing the class tree.
      */
     protected void generateOtherFiles(RootDoc root, ClassTree classtree) throws Exception {
         BuilderFactory builderFactory = configuration.getBuilderFactory();
         AbstractBuilder constantsSummaryBuilder = builderFactory.getConstantsSummaryBuider();
         constantsSummaryBuilder.build();
         AbstractBuilder serializedFormBuilder = builderFactory.getSerializedFormBuilder();
         serializedFormBuilder.build();
     }
     /**
      * Generate the package documentation.
      *
      * @param classtree the data structure representing the class tree.
      */
     protected abstract void generatePackageFiles(ClassTree classtree) throws Exception;
     /**
      * Generate the class documentation.
      *
      * @param classtree the data structure representing the class tree.
      */
     protected abstract void generateClassFiles(ClassDoc[] arr, ClassTree classtree);
     /**
      * Iterate through all classes and construct documentation for them.
      *
      * @param root      the RootDoc of source to document.
      * @param classtree the data structure representing the class tree.
      */
     protected void generateClassFiles(RootDoc root, ClassTree classtree) {
         generateClassFiles(classtree);
         PackageDoc[] packages = root.specifiedPackages();
         for (int i = 0; i < packages.length; i++) {
             generateClassFiles(packages[i].allClasses(), classtree);
         }
     }
     /**
      * Generate the class files for single classes specified on the command line.
      *
      * @param classtree the data structure representing the class tree.
      */
     private void generateClassFiles(ClassTree classtree) {
         String[] packageNames = configuration.classDocCatalog.packageNames();
         for (int packageNameIndex = 0; packageNameIndex < packageNames.length;
                 packageNameIndex++) {
             generateClassFiles(configuration.classDocCatalog.allClasses(
                 packageNames[packageNameIndex]), classtree);
         }
     }
 }

Mercurial > jdk8-mips64-public > langtools / annotate

src/share/classes/com/sun/tools/doclets/internal/toolkit/AbstractDoclet.java@78962d89f283 (annotated)

src/share/classes/com/sun/tools/doclets/internal/toolkit/AbstractDoclet.java