Inquiry Regarding Potential Discrepancies in @since Tags and @API Annotations

[JunggiKim]

/**
* Property name used to set the default timeout for all
* {@link AfterEach @AfterEach} methods: {@value}.
*
*

The value of this property will be used unless overridden by a
* {@link Timeout @timeout} annotation present on the
* {@link AfterEach @AfterEach} method.
*
*

This property overrides the
* {@value #DEFAULT_LIFECYCLE_METHOD_TIMEOUT_PROPERTY_NAME} property.
*
*

Please refer to the class
* description for the definition of supported values.
*
* @SInCE 5.5
*/
@API(status = STABLE, since = "5.9")
String DEFAULT_AFTER_EACH_METHOD_TIMEOUT_PROPERTY_NAME = "junit.jupiter.execution.timeout.aftereach.method.default";

`/**
* Property name used to set the default timeout for all
* {@link AfterAll @afterall} methods: {@value}.
*
*

The value of this property will be used unless overridden by a
* {@link Timeout @timeout} annotation present on the
* {@link AfterAll @afterall} method.
*
*

This property overrides the
* {@value #DEFAULT_LIFECYCLE_METHOD_TIMEOUT_PROPERTY_NAME} property.
*
*

Please refer to the class
* description for the definition of supported values.
*
* @SInCE 5.5
*/
@API(status = STABLE, since = "5.9")
String DEFAULT_AFTER_ALL_METHOD_TIMEOUT_PROPERTY_NAME = "junit.jupiter.execution.timeout.afterall.method.default";

/**
 * Property name used to configure whether timeouts are applied to tests: {@value}.
 *
 * <p>The value of this property will be used to toggle whether
 * {@link Timeout @Timeout} is applied to tests.</p>
 *
 * <h4>Supported timeout mode values:</h4>
 * <ul>
 * <li>{@code enabled}: enables timeouts
 * <li>{@code disabled}: disables timeouts
 * <li>{@code disabled_on_debug}: disables timeouts while debugging
 * </ul>
 *
 * <p>If not specified, the default is {@code enabled}.
 *
 * @since 5.6
 */
@API(status = STABLE, since = "5.9")
String TIMEOUT_MODE_PROPERTY_NAME = "junit.jupiter.execution.timeout.mode";

`

File : org.junit.jupiter.api.Timeout.java

Hello,
I hope this message finds you well. I have been reviewing the @timeout annotation code in the JUnit 5 project and noticed that there might be some discrepancies between the @SInCE tags in the Javadoc comments and the @API annotations used in the code.
As I am not entirely sure if these differences are intentional or if they might be oversights, I wanted to bring them to your attention. If these are indeed discrepancies, I would be grateful for the opportunity to submit a pull request to address any inconsistencies.
Furthermore, I noticed several repeated string literals in the code. Would it be possible for me to refactor these into constants? I ask this cautiously, as I want to ensure that any changes align with the project's coding standards and practices.
If everything is correct as it stands, I apologize for taking your time and would appreciate your clarification on these matters.
Thank you for considering my request, and I would be honored to contribute a pull request if you find the changes necessary.
Best regards,

[mpkorstanje]

The @since tag contains the version of the first introduction of the field. The since property contains the first version of the status.

In other words for

*
 * @since 5.6
 */
@API(status = STABLE, since = "5.9")
String TIMEOUT_MODE_PROPERTY_NAME = "junit.jupiter.execution.timeout.mode";

The constant TIMEOUT_MODE_PROPERTY_NAME was introduced in version 5.6 and became stable in version 5.9.

You can find the documentation here https://apiguardian-team.github.io/apiguardian/docs/current/api/org/apiguardian/api/API.html.

[marcphilipp]

Furthermore, I noticed several repeated string literals in the code. Would it be possible for me to refactor these into constants?

Generally, yes. What did you find?