Skip to content

[Iotdb-2041] Added javadocs for Session and SessionPool and made methods consistent#17459

Open
A0R0P0I7T wants to merge 3 commits intoapache:masterfrom
A0R0P0I7T:IOTDB-2041-javadoc-session
Open

[Iotdb-2041] Added javadocs for Session and SessionPool and made methods consistent#17459
A0R0P0I7T wants to merge 3 commits intoapache:masterfrom
A0R0P0I7T:IOTDB-2041-javadoc-session

Conversation

@A0R0P0I7T
Copy link
Copy Markdown
Contributor

What is changed

This PR adds and improves Javadoc for Session and SessionPool.

  • Added missing Javadoc for constructors, public methods, and selected helper methods
  • Improved clarity of some existing Javadoc where needed
  • Kept the documentation simple and consistent across both classes

Consistency updates

  • Ensured similar methods in Session and SessionPool have consistent descriptions

  • Added references between related methods using @see

  • Clarified the relation between:

    • Session.insertRecordsOfOneDevice
    • SessionPool.insertOneDeviceRecords

Fixes Issue:

Notes

  • Did not modify any method logic or signatures
  • Avoided changing existing Javadoc unless necessary
  • Focused only on missing or unclear documentation

Why this change is needed

Improves readability and usability of the client API by making method behavior easier to understand and documentation more consistent.


This PR has:

  • been self-reviewed.
    • concurrent read
    • concurrent write
    • concurrent read and write
  • added Javadocs for most classes and all non-trivial methods.

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