Skip to content

Docs & Demo polish — add Java 17 helper, richer Javadoc, BOM notes & benchmark comments #1183

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: adv/docs
Choose a base branch
from

Conversation

peter-lawrey
Copy link
Member

@peter-lawrey peter-lawrey commented Jun 2, 2025

Category Scope Details
✅ Java 17 demo bootstrap demo/java17setup.sh Added banner & inline comments explaining why --add-exports/opens are needed.
✅ Maven demo & perf POMs demo/pom.xml, marshallingperf/pom.xml Comment blocks clarifying BOM inheritance, core deps, profiles & exec-plugin purpose.
✅ Source Javadoc sweep demo/src/**, marshallingperf/src/**
wire/* Event & History APIs
Consistent class-level docs, @param/@return tags, “Runs the demo” methods, explains DTO fields.
Event/time-stamp/MessageHistory APIs now fully documented for external users.
✅ Property files demo/system.properties, marshallingperf/system.properties Human-readable comments for every flag.
✅ YAML resources cfg*.yaml Header comment + inline field notes for readability.
🛠️ Minor renames / comment tweaks e.g. EventByMethodExamples inner interfaces No behavioural change.

Important: Only comments, documentation strings and shell-script comments were touched — no production logic altered.

@peter-lawrey peter-lawrey changed the title Adv/35 demos Docs & Demo polish — add Java 17 helper, richer Javadoc, BOM notes & benchmark comments Jun 2, 2025
@peter-lawrey peter-lawrey requested a review from tgd June 3, 2025 11:25
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.

1 participant