Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

`GHDeploymentState` still contains reference to @deprecated javadoc after annotation cleanup

See original GitHub issue

Describe the bug PR #1184 cleaned up the @Deprecated annotations for Preview APIs which is great! However, for GHDeploymentState, the @deprecated javadoc wasn’t removed, see here:

https://github.com/hub4j/github-api/pull/1184/files#diff-e41ba41aaa25735d01eb4efdd7ce10f1cf5c9bfc986a503579a94386ca3744a6R17

To Reproduce Steps to reproduce the behavior:

Use the latest version of this library and have some code like:

var deployment = repo.getDeployment(deploymentId);
deployment.createStatus(state)
    .logUrl(logUrl)
    .create();

Notice that logUrl is still marked as deprecated by IntelliJ because of * @deprecated until preview feature has graduated to stable

Expected behavior The javadoc should have been removed at the same time as the annotation so the method isn’t marked as deprecated.

Library version: 1.135

Issue Analytics

State:
Created 2 years ago
Comments:5 (3 by maintainers)

Top GitHub Comments

1reaction

ReyhanPatriacommented, Nov 2, 2021

Yes, so I’ll removing the @deprecated from the javadoc, correct?

0reactions

ReyhanPatriacommented, Nov 2, 2021

Okay, I’ll work on this ASAP.

Top Results From Across the Web

How and When to Deprecate APIs - Oracle Help Center

Starting with J2SE 5.0, you deprecate a class, method, or field by using the @Deprecated annotation. Additionally, you can use the @deprecated Javadoc...

[RSPEC-1123] Deprecated elements should have both ... - Jira

Deprecation should be marked with both the @Deprecated annotation and @deprecated Javadoc tag. The annotation enables tools such as IDEs to ...

Java @Deprecated Annotation - Baeldung

In this quick tutorial, we'll have a look at deprecated APIs in Java and how to use the @Deprecated annotation.

Java Function Annotation Help, use @Deprecated?

It is certainly possible, however, to display a custom message when the user hovers over the deprecated method. The Javadoc @deprecated tag ...

(ann) @Deprecated annotation has no effect on packages

JDK-6481080 : (ann) @Deprecated annotation has no effect on packages ... Since @Deprecated has explicitly listed its targets since Java SE 7, ...