Skip to content

Commit 8cbf02e

Browse files
authored
docs: document deprecation rationale for getPomFile/setPomFile (apache#11680)
* docs: document deprecation rationale for getPomFile/setPomFile * docs: clarify deprecation replacement for Language.SCRIPT * docs: fix deprecation text format in maven.mdo * docs: remove redundant deprecation tag for Language.SCRIPT * docs: restore 'since' in @deprecated annotation and remove redundancy * docs: restore {@link} reference in deprecation note
1 parent 9b20cb4 commit 8cbf02e

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

api/maven-api-model/src/main/mdo/maven.mdo

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -400,13 +400,18 @@
400400
*
401401
* @return The POM file from which this model originated or {@code null} if this model does not belong to a local
402402
* project (e.g. describes the metadata of some artifact from the repository).
403+
*
404+
* @deprecated Use {@link #getPomPath()} instead.
403405
*/
404-
@Deprecated
406+
@Deprecated(since = "4.0.0")
405407
public java.io.File getPomFile() {
406408
return (getDelegate().getPomFile() != null) ? getDelegate().getPomFile().toFile() : null;
407409
}
408410
409-
@Deprecated
411+
/**
412+
* @deprecated Use {@link #setPomPath(Path)} instead.
413+
*/
414+
@Deprecated(since = "4.0.0")
410415
public void setPomFile(java.io.File pomFile) {
411416
update( getDelegate().withPomFile(pomFile != null ? pomFile.toPath() : null));
412417
}

0 commit comments

Comments
 (0)