Attachment #103733 for bug #211054




	/**
	 * Bug 50695.
	 * @see <a href="http://bugs.eclipse.org/bugs/show_bug.cgi?id=50695">50695</a>
	 * Since bug 211054 was fixed, expect warning to be raised when referencing packages others
	 * than the current one.
	 * @see "https://bugs.eclipse.org/bugs/show_bug.cgi?id=211054"
	 */
	public void testBug50695() {
		runNegativeTest(
			new String[] {
				"X.java",
				"public class X {\n" + 
				"	/**\n" + 
				"	 * @see java\n" + 
				"	 * @see java.util\n" + 
				"	 */\n" + 
				"	void foo() {}\n" + 
				"}\n"
			},
			"----------\n" + 
			"1. ERROR in X.java (at line 3)\n" + 
			"	* @see java\n" + 
			"	       ^^^^\n" + 
			"Javadoc: Invalid reference\n" + 
			"----------\n" + 
			"2. ERROR in X.java (at line 4)\n" + 
			"	* @see java.util\n" + 
			"	       ^^^^^^^^^\n" + 
			"Javadoc: Invalid reference\n" + 
			"----------\n"
		);
	}
	public void testBug50695b() {
		runNegativeTest(

					"	void foo() {}\n" + 
					"}\n"
			 },
			 	"----------\n" + 
				"1. ERROR in X.java (at line 3)\n" + 
				"	* @see java.unknown\n" + 
				"	       ^^^^^^^^^^^^\n" + 

			expectedError
		);
	}
	
	/**
	 * @bug 211054: [javadoc] @see package reference should raise a warning except for the package declaration
	 * @see "https://bugs.eclipse.org/bugs/show_bug.cgi?id=211054"
	 */
	public void testBug211054a() {
		String[] units = new String[] {
			"pkg/X.java",
			"package pkg;\n" +
			"\n" +
			"public class X {\n" +
			"	/**\n" +
			"	 * @see java\n" +
			"	 * @see java.lang\n" +
			"	 * @see PKG\n" +
			"	 * @see pkg\n" +
			"	 */\n" +
			"	public void foo() { \n" +
			"	 \n" +
			"	}\n" +
			"}\n"
		};
		reportInvalidJavadoc = CompilerOptions.WARNING;
		runNegativeTest(units,
			// warning - Tag @see: reference not found: java
			// warning - Tag @see: reference not found: java.lang
			// warning - Tag @see: reference not found: PKG
			"----------\n" + 
			"1. WARNING in pkg\\X.java (at line 5)\n" + 
			"	* @see java\n" + 
			"	       ^^^^\n" + 
			"Javadoc: Invalid reference\n" + 
			"----------\n" + 
			"2. WARNING in pkg\\X.java (at line 6)\n" + 
			"	* @see java.lang\n" + 
			"	       ^^^^^^^^^\n" + 
			"Javadoc: Invalid reference\n" + 
			"----------\n" + 
			"3. WARNING in pkg\\X.java (at line 7)\n" + 
			"	* @see PKG\n" + 
			"	       ^^^\n" + 
			"Javadoc: PKG cannot be resolved to a type\n" + 
			"----------\n");
	}
	public void testBug211054b() {
		String[] units = new String[] {
			"pkg/X.java",
			"package pkg;\n" +
			"\n" +
			"public class X {\n" +
			"	/**\n" +
			"	 * @see java\n" +
			"	 * @see java.lang\n" +
			"	 * @see PKG\n" +
			"	 * @see pkg\n" +
			"	 */\n" +
			"	protected void foo() { \n" +
			"	 \n" +
			"	}\n" +
			"}\n"
		};
		reportInvalidJavadoc = CompilerOptions.WARNING;
		this.reportInvalidJavadocVisibility = CompilerOptions.PUBLIC;
		runConformTest(units);
	}
	public void testBug211054c() {
		String[] units = new String[] {
			"x.y.z/X.java",
			"package x.y.z;\n" +
			"\n" +
			"public class X {\n" +
			"	/**\n" +
			"	 * @see java\n" +
			"	 * @see java.lang\n" +
			"	 * @see x\n" +
			"	 * @see x.y\n" +
			"	 * @see x.y.z\n" +
			"	 */\n" +
			"	public void foo() { \n" +
			"	 \n" +
			"	}\n" +
			"}\n"
		};
		reportInvalidJavadoc = CompilerOptions.WARNING;
		runNegativeTest(units,
			// warning - Tag @see: reference not found: java
			// warning - Tag @see: reference not found: java.lang
			// warning - Tag @see: reference not found: x
			// warning - Tag @see: reference not found: x.y
			"----------\n" + 
			"1. WARNING in x.y.z\\X.java (at line 5)\n" + 
			"	* @see java\n" + 
			"	       ^^^^\n" + 
			"Javadoc: Invalid reference\n" + 
			"----------\n" + 
			"2. WARNING in x.y.z\\X.java (at line 6)\n" + 
			"	* @see java.lang\n" + 
			"	       ^^^^^^^^^\n" + 
			"Javadoc: Invalid reference\n" + 
			"----------\n" + 
			"3. WARNING in x.y.z\\X.java (at line 7)\n" + 
			"	* @see x\n" + 
			"	       ^\n" + 
			"Javadoc: Invalid reference\n" + 
			"----------\n" + 
			"4. WARNING in x.y.z\\X.java (at line 8)\n" + 
			"	* @see x.y\n" + 
			"	       ^^^\n" + 
			"Javadoc: Invalid reference\n" + 
			"----------\n");
	}
}

Lines 50-55 Link Here

(-)compiler/org/eclipse/jdt/internal/compiler/ast/JavadocQualifiedTypeReference.java (+6 lines)
50	Binding binding = scope.getTypeOrPackage(this.tokens);	50	Binding binding = scope.getTypeOrPackage(this.tokens);
51	if (binding instanceof PackageBinding) {	51	if (binding instanceof PackageBinding) {
52	this.packageBinding = (PackageBinding) binding;	52	this.packageBinding = (PackageBinding) binding;
		53	// https://bugs.eclipse.org/bugs/show_bug.cgi?id=211054
		54	// allow references to current package only. All other package references should be reported as invalid
		55	// @see also https://bugs.eclipse.org/bugs/show_bug.cgi?id=50695
		56	if (scope.compilationUnitScope().fPackage != this.packageBinding) {
		57	scope.problemReporter().javadocInvalidReference(this.sourceStart, this.sourceEnd);
		58	}
53	} else {	59	} else {
54	reportInvalidType(scope);	60	reportInvalidType(scope);
55	}	61	}

Lines 65-70 Link Here

(-)compiler/org/eclipse/jdt/internal/compiler/ast/JavadocSingleTypeReference.java (+6 lines)
65	Binding binding = scope.getTypeOrPackage(tokens);	65	Binding binding = scope.getTypeOrPackage(tokens);
66	if (binding instanceof PackageBinding) {	66	if (binding instanceof PackageBinding) {
67	this.packageBinding = (PackageBinding) binding;	67	this.packageBinding = (PackageBinding) binding;
		68	// https://bugs.eclipse.org/bugs/show_bug.cgi?id=211054
		69	// allow references to current package only. All other package references should be reported as invalid
		70	// @see also https://bugs.eclipse.org/bugs/show_bug.cgi?id=50695
		71	if (scope.compilationUnitScope().fPackage != this.packageBinding) {
		72	scope.problemReporter().javadocInvalidReference(this.sourceStart, this.sourceEnd);
		73	}
68	} else {	74	} else {
69	if (this.resolvedType.problemId() == ProblemReasons.NonStaticReferenceInStaticContext) {	75	if (this.resolvedType.problemId() == ProblemReasons.NonStaticReferenceInStaticContext) {
70	TypeBinding closestMatch = this.resolvedType.closestMatch();	76	TypeBinding closestMatch = this.resolvedType.closestMatch();

Return to bug 211054

Lines 1247-1265 Link Here

(-)src/org/eclipse/jdt/core/tests/compiler/regression/JavadocBugsTest.java (-9 / +135 lines)
1247	/**	1247	/**
1248	* Bug 50695.	1248	* Bug 50695.
1249	* @see <a href="http://bugs.eclipse.org/bugs/show_bug.cgi?id=50695">50695</a>	1249	* @see <a href="http://bugs.eclipse.org/bugs/show_bug.cgi?id=50695">50695</a>
		1250	* Since bug 211054 was fixed, expect warning to be raised when referencing packages others
		1251	* than the current one.
		1252	* @see "https://bugs.eclipse.org/bugs/show_bug.cgi?id=211054"
1250	*/	1253	*/
1251	public void testBug50695() {	1254	public void testBug50695() {
1252	runConformTest(	1255	runNegativeTest(
1253	new String[] {	1256	new String[] {
1254	"X.java",	1257	"X.java",
1255	"public class X {\n" +	1258	"public class X {\n" +
1256	" /**\n" +	1259	" /**\n" +
1257	" * @see java\n" +	1260	" * @see java\n" +
1258	" * @see java.util\n" +	1261	" * @see java.util\n" +
1259	" */\n" +	1262	" */\n" +
1260	" void foo() {}\n" +	1263	" void foo() {}\n" +
1261	"}\n"	1264	"}\n"
1262	});	1265	},
		1266	"----------\n" +
		1267	"1. ERROR in X.java (at line 3)\n" +
		1268	" * @see java\n" +
		1269	" ^^^^\n" +
		1270	"Javadoc: Invalid reference\n" +
		1271	"----------\n" +
		1272	"2. ERROR in X.java (at line 4)\n" +
		1273	" * @see java.util\n" +
		1274	" ^^^^^^^^^\n" +
		1275	"Javadoc: Invalid reference\n" +
		1276	"----------\n"
		1277	);
1263	}	1278	}
1264	public void testBug50695b() {	1279	public void testBug50695b() {
1265	runNegativeTest(	1280	runNegativeTest(
Lines 1272-1278 Link Here
1272	" void foo() {}\n" +	1287	" void foo() {}\n" +
1273	"}\n"	1288	"}\n"
1274	},	1289	},
1275	"----------\n" +	1290	"----------\n" +
1276	"1. ERROR in X.java (at line 3)\n" +	1291	"1. ERROR in X.java (at line 3)\n" +
1277	" * @see java.unknown\n" +	1292	" * @see java.unknown\n" +
1278	" ^^^^^^^^^^^^\n" +	1293	" ^^^^^^^^^^^^\n" +
Lines 7284-7287 Link Here
7284	expectedError	7299	expectedError
7285	);	7300	);
7286	}	7301	}
		7302
		7303	/**
		7304	* @bug 211054: [javadoc] @see package reference should raise a warning except for the package declaration
		7305	* @see "https://bugs.eclipse.org/bugs/show_bug.cgi?id=211054"
		7306	*/
		7307	public void testBug211054a() {
		7308	String[] units = new String[] {
		7309	"pkg/X.java",
		7310	"package pkg;\n" +
		7311	"\n" +
		7312	"public class X {\n" +
		7313	" /**\n" +
		7314	" * @see java\n" +
		7315	" * @see java.lang\n" +
		7316	" * @see PKG\n" +
		7317	" * @see pkg\n" +
		7318	" */\n" +
		7319	" public void foo() { \n" +
		7320	" \n" +
		7321	" }\n" +
		7322	"}\n"
		7323	};
		7324	reportInvalidJavadoc = CompilerOptions.WARNING;
		7325	runNegativeTest(units,
		7326	// warning - Tag @see: reference not found: java
		7327	// warning - Tag @see: reference not found: java.lang
		7328	// warning - Tag @see: reference not found: PKG
		7329	"----------\n" +
		7330	"1. WARNING in pkg\\X.java (at line 5)\n" +
		7331	" * @see java\n" +
		7332	" ^^^^\n" +
		7333	"Javadoc: Invalid reference\n" +
		7334	"----------\n" +
		7335	"2. WARNING in pkg\\X.java (at line 6)\n" +
		7336	" * @see java.lang\n" +
		7337	" ^^^^^^^^^\n" +
		7338	"Javadoc: Invalid reference\n" +
		7339	"----------\n" +
		7340	"3. WARNING in pkg\\X.java (at line 7)\n" +
		7341	" * @see PKG\n" +
		7342	" ^^^\n" +
		7343	"Javadoc: PKG cannot be resolved to a type\n" +
		7344	"----------\n");
		7345	}
		7346	public void testBug211054b() {
		7347	String[] units = new String[] {
		7348	"pkg/X.java",
		7349	"package pkg;\n" +
		7350	"\n" +
		7351	"public class X {\n" +
		7352	" /**\n" +
		7353	" * @see java\n" +
		7354	" * @see java.lang\n" +
		7355	" * @see PKG\n" +
		7356	" * @see pkg\n" +
		7357	" */\n" +
		7358	" protected void foo() { \n" +
		7359	" \n" +
		7360	" }\n" +
		7361	"}\n"
		7362	};
		7363	reportInvalidJavadoc = CompilerOptions.WARNING;
		7364	this.reportInvalidJavadocVisibility = CompilerOptions.PUBLIC;
		7365	runConformTest(units);
7366	}
7367	public void testBug211054c() {
7368	String[] units = new String[] {
7369	"x.y.z/X.java",
7370	"package x.y.z;\n" +
7371	"\n" +
7372	"public class X {\n" +
7373	" /**\n" +
7374	" * @see java\n" +
7375	" * @see java.lang\n" +
7376	" * @see x\n" +
7377	" * @see x.y\n" +
7378	" * @see x.y.z\n" +
7379	" */\n" +
7380	" public void foo() { \n" +
7381	" \n" +
7382	" }\n" +
7383	"}\n"
7384	};
7385	reportInvalidJavadoc = CompilerOptions.WARNING;
7386	runNegativeTest(units,
7387	// warning - Tag @see: reference not found: java
7388	// warning - Tag @see: reference not found: java.lang
7389	// warning - Tag @see: reference not found: x
7390	// warning - Tag @see: reference not found: x.y
7391	"----------\n" +
7392	"1. WARNING in x.y.z\\X.java (at line 5)\n" +
7393	" * @see java\n" +
7394	" ^^^^\n" +
7395	"Javadoc: Invalid reference\n" +
7396	"----------\n" +
7397	"2. WARNING in x.y.z\\X.java (at line 6)\n" +
7398	" * @see java.lang\n" +
7399	" ^^^^^^^^^\n" +
7400	"Javadoc: Invalid reference\n" +
7401	"----------\n" +
7402	"3. WARNING in x.y.z\\X.java (at line 7)\n" +
7403	" * @see x\n" +
7404	" ^\n" +
7405	"Javadoc: Invalid reference\n" +
7406	"----------\n" +
7407	"4. WARNING in x.y.z\\X.java (at line 8)\n" +
7408	" * @see x.y\n" +
7409	" ^^^\n" +
7410	"Javadoc: Invalid reference\n" +
7411	"----------\n");
7412	}
7287	}	7413	}