Skip to content

fix: use single-line comments for SNIP markers to avoid NotJavadoc warnings#765

Merged
maciejdudko merged 1 commit intotemporalio:mainfrom
mfateev:task/fix-build-issues-samples-java
Jan 12, 2026
Merged

fix: use single-line comments for SNIP markers to avoid NotJavadoc warnings#765
maciejdudko merged 1 commit intotemporalio:mainfrom
mfateev:task/fix-build-issues-samples-java

Conversation

@mfateev
Copy link
Member

@mfateev mfateev commented Jan 9, 2026

Summary

  • Changed SNIP markers from /** block comments to // single-line comments in envconfig samples
  • Fixes ErrorProne's NotJavadoc warnings that were causing build failures with -Werror

Files Changed

  • core/src/main/java/io/temporal/samples/envconfig/LoadFromFile.java
  • core/src/main/java/io/temporal/samples/envconfig/LoadProfile.java

Test plan

  • ./gradlew :core:compileJava passes
  • ./gradlew build -x :springboot:test passes (excluding pre-existing test failure)

Note: HelloSampleTestMockedActivity test failure is a pre-existing issue unrelated to this change.

…rnings

ErrorProne's NotJavadoc check flags `/**` block comments that aren't
actual Javadoc. The SNIP markers are for documentation extraction,
not Javadoc, so use `//` single-line comments instead.
@mfateev mfateev requested review from a team, antmendoza and tsurdilo as code owners January 9, 2026 20:04
@maciejdudko maciejdudko merged commit dfef8ac into temporalio:main Jan 12, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants