Deprecate JctCompilationAssert#generatedHeaders

ascopes · ascopes · commit a5369d01ba25 · 2023-04-08T12:20:32.000+01:00
diff --git a/java-compiler-testing/src/main/java/io/github/ascopes/jct/assertions/JctCompilationAssert.java b/java-compiler-testing/src/main/java/io/github/ascopes/jct/assertions/JctCompilationAssert.java
@@ -264,7 +264,11 @@ public OutputContainerGroupAssert sourceOutput() {
    *
    * @return the assertions to perform on the header outputs.
    * @throws AssertionError if the compilation is null.
+   * @deprecated this method is rarely needed, so is being removed in v1.0.0. Use
+   * {@link #outputGroup(Location)}, passing {@link StandardLocation#NATIVE_HEADER_OUTPUT} as the
+   * first parameter instead.
    */
+  @Deprecated(since = "0.6.0", forRemoval = true)
   public OutputContainerGroupAssert generatedHeaders() {
     return outputGroup(StandardLocation.NATIVE_HEADER_OUTPUT);
   }

Original file line number	Diff line number	Diff line change
`@@ -264,7 +264,11 @@ public OutputContainerGroupAssert sourceOutput() {`
`264`	`264`	`*`
`265`	`265`	`* @return the assertions to perform on the header outputs.`
`266`	`266`	`* @throws AssertionError if the compilation is null.`
	`267`	`+ * @deprecated this method is rarely needed, so is being removed in v1.0.0. Use`
	`268`	`+ * {@link #outputGroup(Location)}, passing {@link StandardLocation#NATIVE_HEADER_OUTPUT} as the`
	`269`	`+ * first parameter instead.`
`267`	`270`	`*/`
	`271`	`+ @Deprecated(since = "0.6.0", forRemoval = true)`
`268`	`272`	`public OutputContainerGroupAssert generatedHeaders() {`
`269`	`273`	`return outputGroup(StandardLocation.NATIVE_HEADER_OUTPUT);`
`270`	`274`	`}`