author | bpatel |
Sat, 29 Mar 2014 11:06:33 -0700 | |
changeset 23799 | daa645653200 |
parent 17578 | 46ac954e4a84 |
child 24069 | dfb8f11542fc |
permissions | -rw-r--r-- |
10 | 1 |
/* |
17578 | 2 |
* Copyright (c) 2001, 2013, Oracle and/or its affiliates. All rights reserved. |
10 | 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 |
|
5520 | 7 |
* published by the Free Software Foundation. Oracle designates this |
10 | 8 |
* particular file as subject to the "Classpath" exception as provided |
5520 | 9 |
* by Oracle in the LICENSE file that accompanied this code. |
10 | 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 |
* |
|
5520 | 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. |
|
10 | 24 |
*/ |
25 |
||
26 |
package com.sun.tools.javadoc; |
|
27 |
||
13077 | 28 |
import javax.tools.JavaFileObject; |
29 |
||
10 | 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.*; |
|
13077 | 34 |
import com.sun.tools.javac.util.Context; |
35 |
import com.sun.tools.javac.util.JCDiagnostic.DiagnosticPosition; |
|
36 |
import com.sun.tools.javac.util.List; |
|
10 | 37 |
|
38 |
/** |
|
39 |
* Javadoc's own enter phase does a few things above and beyond that |
|
40 |
* done by javac. |
|
14260
727a84636f12
8000665: fix "internal API" comments on javadoc files
jjg
parents:
14258
diff
changeset
|
41 |
* |
727a84636f12
8000665: fix "internal API" comments on javadoc files
jjg
parents:
14258
diff
changeset
|
42 |
* <p><b>This is NOT part of any supported API. |
727a84636f12
8000665: fix "internal API" comments on javadoc files
jjg
parents:
14258
diff
changeset
|
43 |
* If you write code that depends on this, you do so at your own risk. |
727a84636f12
8000665: fix "internal API" comments on javadoc files
jjg
parents:
14258
diff
changeset
|
44 |
* This code and its internal interfaces are subject to change or |
727a84636f12
8000665: fix "internal API" comments on javadoc files
jjg
parents:
14258
diff
changeset
|
45 |
* deletion without notice.</b> |
727a84636f12
8000665: fix "internal API" comments on javadoc files
jjg
parents:
14258
diff
changeset
|
46 |
* |
10 | 47 |
* @author Neal Gafter |
48 |
*/ |
|
49 |
public class JavadocEnter extends Enter { |
|
50 |
public static JavadocEnter instance0(Context context) { |
|
51 |
Enter instance = context.get(enterKey); |
|
52 |
if (instance == null) |
|
53 |
instance = new JavadocEnter(context); |
|
54 |
return (JavadocEnter)instance; |
|
55 |
} |
|
56 |
||
8614 | 57 |
public static void preRegister(Context context) { |
10 | 58 |
context.put(enterKey, new Context.Factory<Enter>() { |
8614 | 59 |
public Enter make(Context c) { |
60 |
return new JavadocEnter(c); |
|
10 | 61 |
} |
62 |
}); |
|
63 |
} |
|
64 |
||
65 |
protected JavadocEnter(Context context) { |
|
66 |
super(context); |
|
67 |
messager = Messager.instance0(context); |
|
68 |
docenv = DocEnv.instance(context); |
|
69 |
} |
|
70 |
||
71 |
final Messager messager; |
|
72 |
final DocEnv docenv; |
|
73 |
||
10203
cca843a7d258
7064544: (javadoc) miscellaneous fixes requested by netbeans
ksrini
parents:
8614
diff
changeset
|
74 |
@Override |
10 | 75 |
public void main(List<JCCompilationUnit> trees) { |
76 |
// count all Enter errors as warnings. |
|
77 |
int nerrors = messager.nerrors; |
|
78 |
super.main(trees); |
|
79 |
messager.nwarnings += (messager.nerrors - nerrors); |
|
80 |
messager.nerrors = nerrors; |
|
81 |
} |
|
82 |
||
10203
cca843a7d258
7064544: (javadoc) miscellaneous fixes requested by netbeans
ksrini
parents:
8614
diff
changeset
|
83 |
@Override |
10 | 84 |
public void visitTopLevel(JCCompilationUnit tree) { |
85 |
super.visitTopLevel(tree); |
|
86 |
if (tree.sourcefile.isNameCompatible("package-info", JavaFileObject.Kind.SOURCE)) { |
|
14802 | 87 |
docenv.makePackageDoc(tree.packge, docenv.getTreePath(tree)); |
10 | 88 |
} |
89 |
} |
|
90 |
||
10203
cca843a7d258
7064544: (javadoc) miscellaneous fixes requested by netbeans
ksrini
parents:
8614
diff
changeset
|
91 |
@Override |
10 | 92 |
public void visitClassDef(JCClassDecl tree) { |
93 |
super.visitClassDef(tree); |
|
10203
cca843a7d258
7064544: (javadoc) miscellaneous fixes requested by netbeans
ksrini
parents:
8614
diff
changeset
|
94 |
if (tree.sym == null) return; |
cca843a7d258
7064544: (javadoc) miscellaneous fixes requested by netbeans
ksrini
parents:
8614
diff
changeset
|
95 |
if (tree.sym.kind == Kinds.TYP || tree.sym.kind == Kinds.ERR) { |
868 | 96 |
ClassSymbol c = tree.sym; |
14802 | 97 |
docenv.makeClassDoc(c, docenv.getTreePath(env.toplevel, tree)); |
10 | 98 |
} |
99 |
} |
|
100 |
||
101 |
/** Don't complain about a duplicate class. */ |
|
10203
cca843a7d258
7064544: (javadoc) miscellaneous fixes requested by netbeans
ksrini
parents:
8614
diff
changeset
|
102 |
@Override |
10 | 103 |
protected void duplicateClass(DiagnosticPosition pos, ClassSymbol c) {} |
104 |
||
105 |
} |