aehrc / aehrc/fhir-bulk-java

Lombok-generated builder methods are not included in Javadoc

Open
#7 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug documentation
Dominant language
Java
Stars
6
Forks
0
PR merge metrics
No merged PRs in 30d

Description

Most of the methods in the BulkExportClient builder are not visible in the Javadocs - I suspect this is because they are generated by @Builder.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the BulkExportClient builder and its @Builder annotation, then inspect how the project's Javadoc is generated. Confirm that the Lombok-generated builder methods appear in the resulting Javadocs; the issue does not name a test or configuration entry point.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.