docs: document deprecation rationale for getPomFile/setPomFile#11680
docs: document deprecation rationale for getPomFile/setPomFile#11680elharo merged 6 commits intoapache:masterfrom
Conversation
|
This is again wrong, version 4.0.0 of Maven was not even released. |
|
Thanks — you’re right. I’ve replaced the JavaDoc link with plain text in the .mdo file and kept the deprecation version-agnostic. |
| * The "script" language. Provided for compatibility with Maven 3. | ||
| * | ||
| * @deprecated Use {@link #RESOURCES} instead. | ||
| * @deprecated since 4.0.0. |
There was a problem hiding this comment.
This is pulling in changes from other PRs. remove from this PR
There was a problem hiding this comment.
Thanks for catching that — I’ve removed the unrelated Language.java changes so this PR now only contains the maven.mdo updates.
There was a problem hiding this comment.
but it's once again including redundant info
elharo
left a comment
There was a problem hiding this comment.
needs to sync with master
f22b4c0 to
5399a8b
Compare
Rebased this branch on the latest upstream/master and resolved conflicts in |
| * The "script" language. Provided for compatibility with Maven 3. | ||
| * | ||
| * @deprecated Use {@link #RESOURCES} instead. | ||
| * @deprecated since 4.0.0. |
There was a problem hiding this comment.
but it's once again including redundant info
|
Thanks for the note. I kept a single |
| * Use {@link #getPomPath()} instead. | ||
| * @deprecated Use getPomPath() instead. | ||
| */ | ||
| @Deprecated |
There was a problem hiding this comment.
now you've lost since in the annotation
There was a problem hiding this comment.
Thanks for catching that. I’ve restored the since = "4.0.0" value in the @Deprecated annotation and kept a single Javadoc @deprecated entry with the replacement reference.
| * | ||
| * @deprecated since 4.0.0. | ||
| * Use {@link #getPomPath()} instead. | ||
| * @deprecated Use getPomPath() instead. |
There was a problem hiding this comment.
We lost the {@link} with this change.
There was a problem hiding this comment.
Good catch, thanks. I’ve restored the {@link} reference in the deprecation Javadoc so the method remains properly linked.
|
@elharo Please assign appropriate label to PR according to the type of change. |
|
Thank you for the review and merge 🙂 |
Fixes #11674
Documents the deprecation rationale and recommended replacement for the model API methods getPomFile() and setPomFile(File).
This change is documentation-only and does not affect runtime behavior.
Build: mvn -DskipTests -pl api/maven-api-model -am verify
Following this checklist to help us incorporate your
contribution quickly and easily:
Note that commits might be squashed by a maintainer on merge.
This may not always be possible but is a best-practice.
mvn verifyto make sure basic checks pass.A more thorough check will be performed on your pull request automatically.
If your pull request is about ~20 lines of code you don't need to sign an
Individual Contributor License Agreement if you are unsure
please ask on the developers list.
To make clear that you license your contribution under
the Apache License Version 2.0, January 2004
you have to acknowledge this by using the following check-box.