Polishes wording across the README, supporting AsciiDoc files, and Java comments/Javadocs.

[peter-lawrey]

This is a documentation-only cleanup. It standardises terminology such as thread-safety, memory-mapped, low-level, and filename, and tightens a number of API descriptions without changing runtime behaviour.

What changed

• Updated README.adoc wording for consistency and readability

• Polished supporting documentation, including:

  • docs/systemProperties.adoc
  • src/main/docs/StackTrace-user-guide.adoc
  • src/main/docs/decision-log.adoc
  • src/main/docs/deterministic-resource-management.adoc
  • src/main/docs/thread-safety-guarantees.adoc

• Cleaned up Java comments and Javadocs across core, IO, pool, util, analytics, shutdown, time, and values packages

• Standardised common terms and phrasing, including:

  • memory mapped -> memory-mapped
  • thread safety / non thread safe -> thread-safety / non-thread-safe
  • low level -> low-level
  • file name -> filename

• Tightened a number of descriptions to better match method behaviour, for example:

  • “retrieve” -> “returns” where a method returns a value
  • “retrieves into” -> “copies into” where a target object is populated
  • parameter docs updated from “the class to retrieve … for” to “the class whose … is returned”

• Fixed a handful of small grammar/style issues in Javadocs and comments

Impact

• No intended production or runtime behaviour change
• No API semantics change
• Improves consistency across README, AsciiDoc docs, and generated Javadocs
• Makes terminology and method descriptions easier to scan and more precise

Reviewer notes

• Java source files touched in this PR are comment/Javadoc wording cleanups only; there are no intended logic changes
• The main thing to check is that any wording tightenings still accurately describe current behaviour
• In particular, it is worth sanity-checking the places where wording shifts from “retrieve” to “returns” / “copies”, to ensure the docs remain semantically exact

Validation

• git diff --check origin/develop..HEAD

Notes

This PR intentionally keeps scope to wording and documentation polish. Any behavioural or API changes should be handled separately.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud