jdk8-mips64-public/langtools: src/share/classes/com/sun/tools/javadoc/JavadocEnter.java@78962d89f283

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

     1 /*

     2  * Copyright (c) 2001, 2012, 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  */

    26 package com.sun.tools.javadoc;

    28 import javax.tools.JavaFileObject;

    30 import com.sun.tools.javac.code.Kinds;

    31 import com.sun.tools.javac.code.Symbol.*;

    32 import com.sun.tools.javac.comp.Enter;

    33 import com.sun.tools.javac.tree.JCTree.*;

    34 import com.sun.tools.javac.tree.TreeInfo;

    35 import com.sun.tools.javac.util.Context;

    36 import com.sun.tools.javac.util.JCDiagnostic.DiagnosticPosition;

    37 import com.sun.tools.javac.util.List;

    39 /**

    40  *  Javadoc's own enter phase does a few things above and beyond that

    41  *  done by javac.

    42  *

    43  *  <p><b>This is NOT part of any supported API.

    44  *  If you write code that depends on this, you do so at your own risk.

    45  *  This code and its internal interfaces are subject to change or

    46  *  deletion without notice.</b>

    47  *

    48  *  @author Neal Gafter

    49  */

    50 public class JavadocEnter extends Enter {

    51     public static JavadocEnter instance0(Context context) {

    52         Enter instance = context.get(enterKey);

    53         if (instance == null)

    54             instance = new JavadocEnter(context);

    55         return (JavadocEnter)instance;

    56     }

    58     public static void preRegister(Context context) {

    59         context.put(enterKey, new Context.Factory<Enter>() {

    60                public Enter make(Context c) {

    61                    return new JavadocEnter(c);

    62                }

    63         });

    64     }

    66     protected JavadocEnter(Context context) {

    67         super(context);

    68         messager = Messager.instance0(context);

    69         docenv = DocEnv.instance(context);

    70     }

    72     final Messager messager;

    73     final DocEnv docenv;

    75     @Override

    76     public void main(List<JCCompilationUnit> trees) {

    77         // count all Enter errors as warnings.

    78         int nerrors = messager.nerrors;

    79         super.main(trees);

    80         messager.nwarnings += (messager.nerrors - nerrors);

    81         messager.nerrors = nerrors;

    82     }

    84     @Override

    85     public void visitTopLevel(JCCompilationUnit tree) {

    86         super.visitTopLevel(tree);

    87         if (tree.sourcefile.isNameCompatible("package-info", JavaFileObject.Kind.SOURCE)) {

    88             String comment = TreeInfo.getCommentText(env, tree);

    89             docenv.makePackageDoc(tree.packge, comment, tree);

    90         }

    91     }

    93     @Override

    94     public void visitClassDef(JCClassDecl tree) {

    95         super.visitClassDef(tree);

    96         if (tree.sym == null) return;

    97         if (tree.sym.kind == Kinds.TYP || tree.sym.kind == Kinds.ERR) {

    98             String comment = TreeInfo.getCommentText(env, tree);

    99             ClassSymbol c = tree.sym;

   100             docenv.makeClassDoc(c, comment, tree, env.toplevel.lineMap);

   101         }

   102     }

   104     /** Don't complain about a duplicate class. */

   105     @Override

   106     protected void duplicateClass(DiagnosticPosition pos, ClassSymbol c) {}

   108 }

Mercurial > jdk8-mips64-public > langtools / file revision