Skip to content

feat: add generateJavaDoc option to disable Javadoc generation (#262) - #265

Merged
AndreasIgel merged 18 commits into
java-helpers:mainfrom
AndreasIgel:devin/fix-issue-262-generate-javadoc
Aug 25, 2026
Merged

feat: add generateJavaDoc option to disable Javadoc generation (#262)#265
AndreasIgel merged 18 commits into
java-helpers:mainfrom
AndreasIgel:devin/fix-issue-262-generate-javadoc

Conversation

@AndreasIgel

@AndreasIgelAndreasIgel commented Aug 22, 2026

Copy link
Copy Markdown
Collaborator

Summary

Add a new generateJavaDoc option to @SimpleBuilder.Options that controls whether the processor emits Javadoc comments on generated builder classes and members. Defaults to ENABLED for full backward compatibility.

Changes

  • Added generateJavaDoc() to SimpleBuilder.Options (default UNSET, merges to ENABLED from defaults).
  • Added generateJavaDoc to BuilderConfiguration with convenience shouldGenerateJavaDoc() accessor.
  • Wired the option through CompilerArgumentsEnum, CompilerArgumentsReader, and BuilderConfigurationReader.
  • Updated RoasterCodeGenerator to skip Javadoc rendering when the effective configuration disables it.
  • BuilderProcessor passes the current ProcessingContext to RoasterCodeGenerator and sets the global config before Jackson module generation.
  • Added tests in ConfigurationProcessingTest:
    • default behaviour still generates Javadoc
    • @SimpleBuilder(options = @SimpleBuilder.Options(generateJavaDoc = OptionState.DISABLED)) produces no Javadoc
    • -Asimplebuilder.generateJavaDoc=false produces no Javadoc
  • Updated docs/CONFIGURATION.md and SimpleBuilder Javadoc with the new option.

Verification

mvn -pl core,processor,example test -am passes with 345 processor tests and the example module builds successfully.

AndreasIgeland others added 14 commits August 15, 2026 10:57
@AndreasIgel@devin-ai-integration
Make @SimpleBuilder@inheritedto match documentation (java-helpers#244)
fff0ff1
The class-level Javadoc and docs/CONFIGURATION.md implied that
@SimpleBuilder is inherited by subclasses, but the annotation was not
meta-annotated with @inherited. As a result BuilderProcessor, which
collects types via RoundEnvironment.getElementsAnnotatedWith(...),
only produced builders for the exact type carrying @SimpleBuilder and
not for unannotated subclasses.
Add @inherited to @SimpleBuilder so subclasses are treated as if they
also carried the annotation, mirroring the existing behaviour of
@SimpleBuilder.Template (which is already @inherited). Update the
Javadoc to document the inheritance explicitly and clarify the
CONFIGURATION.md wording. @Ignore4BuilderGeneration still suppresses
generation for the exact type it is placed on, so opt-outs continue
to work as before.
Add SimpleBuilderInheritanceTest covering direct inheritance, the
opt-out interaction, and multi-level (grandchild) inheritance.
Closesjava-helpers#244
Generated with [Devin](https://devin.ai)
Co-Authored-By: Devin <158243242+devin-ai-integration[bot]@users.noreply.github.com>
@AndreasIgel@devin-ai-integration
Rename to BuilderAnnotationInheritanceTest and cover Template inherit…
13a8fc8
…ance
Rename SimpleBuilderInheritanceTest to BuilderAnnotationInheritanceTest
so the name reflects that it covers both builder-triggering annotations.
Add unannotatedSubclassGetsBuilderFromInheritedTemplate, which verifies
that a custom @inherited template annotation (meta-annotated with
@SimpleBuilder.Template) propagates to unannotated subclasses, matching
the existing behaviour of @SimpleBuilder itself.
Generated with [Devin](https://devin.ai)
Co-Authored-By: Devin <158243242+devin-ai-integration[bot]@users.noreply.github.com>
@AndreasIgel
Refactoring code to move assertNoBuilderGenerated to common asserts
105310a
@AndreasIgel
fixing codeformat
2c83b78
@AndreasIgel@devin-ai-integration
Document@inheritedbehavior of @SimpleBuilder.Template
aca9ef6
The Template Javadoc and CONFIGURATION.md "Template Annotations" section
did not explain that @SimpleBuilder.Template is @inherited, nor that a
custom template annotation must additionally declare @inherited to
propagate to unannotated subclasses. Add explicit documentation and an
example showing the @inherited custom annotation pattern.
Also move assertNoBuilderGenerated to ProcessorAsserts so it is shared
by BuilderAnnotationInheritanceTest and Ignore4BuilderGenerationTest
instead of being duplicated as a private helper in each test class.
Generated with [Devin](https://devin.ai)
Co-Authored-By: Devin <158243242+devin-ai-integration[bot]@users.noreply.github.com>
@AndreasIgel@devin-ai-integration
Document options-inheritance limitation for inherited subclass builders
bd3bf93
While @SimpleBuilder and @inherited template annotations now correctly
trigger builder generation for unannotated subclasses, the configuration
options declared on the parent's @SimpleBuilder(options = ...) or template
are not yet applied to inherited subclass builders — they use default
options instead. This is tracked separately in issue java-helpers#245.
Add caveats to the SimpleBuilder Javadoc, the CONFIGURATION.md Template
Annotations section, and the Template Annotations Not Working
troubleshooting section so users are not surprised by this limitation.
Generated with [Devin](https://devin.ai)
Co-Authored-By: Devin <158243242+devin-ai-integration[bot]@users.noreply.github.com>
@AndreasIgel@devin-ai-integration
Fix issue reference:java-helpers#245->java-helpers#248
e8e0352
Generated with [Devin](https://devin.ai)
Co-Authored-By: Devin <158243242+devin-ai-integration[bot]@users.noreply.github.com>
@AndreasIgel@devin-ai-integration
Clarify @SimpleBuilder vs @SimpleBuilder.Template usage in docs
9776343
Add explicit guidance that @SimpleBuilder.Template is a meta-annotation
for custom annotation declarations (@interface) only and cannot be
placed directly on a class or record. @SimpleBuilder is for direct
one-off annotation of classes/records.
- SimpleBuilder.java: add 'When to use' section to class-level Javadoc
- SimpleBuilder.Template Javadoc: state it can only be placed on
annotation types (ANNOTATION_TYPE), not on classes/records
- CONFIGURATION.md 'Template Annotations': add comparison table and
introductory paragraph
- CONFIGURATION.md troubleshooting: add item about @SimpleBuilder.Template
not being a class annotation
Generated with [Devin](https://devin.ai)
Co-Authored-By: Devin <158243242+devin-ai-integration[bot]@users.noreply.github.com>
@AndreasIgel@devin-ai-integration
Link issuejava-helpers#248from @SimpleBuilder.Template inheritance …
4b7723a
…Javadoc
Generated with [Devin](https://devin.ai)
Co-Authored-By: Devin <158243242+devin-ai-integration[bot]@users.noreply.github.com>
@AndreasIgel@devin-ai-integration
Remove redundant troubleshooting item about @SimpleBuilder.Template t…
218ea79
…arget
The compiler and IDE already enforce @target(ANNOTATION_TYPE) and show
a clear error when @SimpleBuilder.Template is placed on a class/record,
so this troubleshooting item adds no value.
Generated with [Devin](https://devin.ai)
Co-Authored-By: Devin <158243242+devin-ai-integration[bot]@users.noreply.github.com>
@devin-ai-integration
Merge remote-tracking branch 'upstream/main'
bd6020d
@devin-ai-integration
Merge remote-tracking branch 'upstream/main'
62d1269
@devin-ai-integration
Merge upstream main
ec99605
@devin-ai-integration@AndreasIgelCC
feat: add generateJavaDoc option to disable Javadoc generation (java-…
77bfb8b
…helpers#262)
Co-Authored-By: Andreas Igel <andreas.igel@computacenter.com>
@codecov

codecovBot commented Aug 22, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ All tests successful. No failed tests found.

📢 Thoughts on this report? Let us know!

@devin-ai-integration@AndreasIgelCC
fix(java-helpers#262): move generateJavaDoc gating from RoasterCodeGe…
25c5fa4
…nerator to BuilderToGenerationTypeMapper
- RoasterCodeGenerator is again a pure renderer; it no longer inspects ProcessingContext.
- BuilderToGenerationTypeMapper accepts the ProcessingContext and strips all JavadocDto
instances from the rendering DTO when shouldGenerateJavaDoc() is false.
- BuilderProcessor passes the context to toRenderingDto and uses the two-arg
RoasterCodeGenerator constructor.
Co-Authored-By: Andreas Igel <andreas.igel@computacenter.com>
AndreasIgel
AndreasIgel commented Aug 23, 2026
View reviewed changes
Comment threadcore/src/main/java/org/javahelpers/simple/builders/core/annotations/SimpleBuilder.java Outdated
Comment threaddocs/CONFIGURATION.md
Comment thread...java/org/javahelpers/simple/builders/processor/model/core/BuilderToGenerationTypeMapper.java Outdated
Comment thread...java/org/javahelpers/simple/builders/processor/model/core/BuilderToGenerationTypeMapper.java Outdated
@devin-ai-integration@AndreasIgelCC
refactor(java-helpers#262): address PR feedback on generateJavaDoc im…
ba774bf
…plementation
- Remove stray // === Documentation === separator in SimpleBuilder.Options.
- Disable generateJavaDoc in @SimpleMinimalBuilder.
- Make BuilderToGenerationTypeMapper instance-based with BuilderConfiguration
as a member; drop boolean selector parameters and ProcessingContext passing.
- Update BuilderProcessor to instantiate the mapper with the effective config.
- Update SimpleMinimalBuilderTest expected output to match no-Javadoc builds.
- Regenerate CustomerDtoBuilder example without Javadoc.
Co-Authored-By: Andreas Igel <andreas.igel@computacenter.com>
@devin-ai-integration
devin-ai-integrationBotforce-pushed the devin/fix-issue-262-generate-javadoc branch from c3aaa11 to ba774bfCompareAugust 23, 2026 10:17
AndreasIgel
AndreasIgel commented Aug 23, 2026
View reviewed changes
Comment thread...java/org/javahelpers/simple/builders/processor/model/core/BuilderToGenerationTypeMapper.java Outdated
Comment thread...java/org/javahelpers/simple/builders/processor/model/core/BuilderToGenerationTypeMapper.java Outdated
Comment thread...java/org/javahelpers/simple/builders/processor/model/core/BuilderToGenerationTypeMapper.java
Comment thread...java/org/javahelpers/simple/builders/processor/model/core/BuilderToGenerationTypeMapper.java Outdated
Comment thread...java/org/javahelpers/simple/builders/processor/model/core/BuilderToGenerationTypeMapper.java Outdated
Comment thread...java/org/javahelpers/simple/builders/processor/model/core/BuilderToGenerationTypeMapper.java Outdated
Comment thread...sor/src/test/java/org/javahelpers/simple/builders/processor/ConfigurationProcessingTest.java Outdated
@AndreasIgelAndreasIgel linked an issue Aug 23, 2026 that may be closed by this pull request
Adding a property to disable Javadoc generation #262
Closed
devin-ai-integrationBotand others added 2 commits August 24, 2026 10:52
@devin-ai-integration@AndreasIgelCC
refactor: remove cached generateJavaDoc flag and add full expected so…
9b48214
…urce assertion
- BuilderToGenerationTypeMapper now calls configuration.shouldGenerateJavaDoc() directly, drops null-safe constructor handling, and streamifies field/constructor mapping
- Extracted method Javadoc enrichment into buildMethodJavadoc()
- ConfigurationProcessingTest.inlineOptions_generateJavaDocDisabled_ShouldNotGenerateJavadoc now asserts the complete generated source via a text block
Co-Authored-By: Andreas Igel <andreas.igel@computacenter.com>
@AndreasIgel
Merge branch 'main' into devin/fix-issue-262-generate-javadoc
77091e0
@AndreasIgel
AndreasIgel merged commit fd51d02 into java-helpers:mainAug 25, 2026
6 checks passed
@AndreasIgel
AndreasIgel deleted the devin/fix-issue-262-generate-javadoc branch August 25, 2026 20:16
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Adding a property to disable Javadoc generation

1 participant

@AndreasIgel