Skip to content

docs(core): enhance documentation and add core interfaces#1011

Merged
Ahoo-Wang merged 1 commit into
mainfrom
comments
Apr 13, 2026
Merged

docs(core): enhance documentation and add core interfaces#1011
Ahoo-Wang merged 1 commit into
mainfrom
comments

Conversation

@Ahoo-Wang
Copy link
Copy Markdown
Owner

  • Add comprehensive Javadoc comments to FieldGetter and FieldSetter classes
  • Add detailed documentation to MethodGetter and MethodSetter with parameter descriptions
  • Enhance CompositeFieldDefinitionParser with usage explanation
  • Add documentation to CosIdAccessorParser interface and its parse method
  • Document DefaultAccessorParser with implementation details and capitalization utility
  • Add comprehensive interface documentation for CosIdAccessorRegistry
  • Create new CosIdGetter interface for ID value extraction from objects
  • Create new CosIdSetter interface for ID value assignment to objects
  • Add new DefaultCosIdAccessor implementation with complete ID handling logic
  • Document IdMetadata interface with ID field information access methods
  • Add new exception classes IdTypeNotSupportException and MultipleIdNotSupportException
  • Enhance annotation documentation for CosId with detailed usage instructions
  • Improve documentation for various ID converter implementations
  • Add new registry and scanner components with complete JavaDoc coverage

- Add comprehensive Javadoc comments to FieldGetter and FieldSetter classes
- Add detailed documentation to MethodGetter and MethodSetter with parameter descriptions
- Enhance CompositeFieldDefinitionParser with usage explanation
- Add documentation to CosIdAccessorParser interface and its parse method
- Document DefaultAccessorParser with implementation details and capitalization utility
- Add comprehensive interface documentation for CosIdAccessorRegistry
- Create new CosIdGetter interface for ID value extraction from objects
- Create new CosIdSetter interface for ID value assignment to objects
- Add new DefaultCosIdAccessor implementation with complete ID handling logic
- Document IdMetadata interface with ID field information access methods
- Add new exception classes IdTypeNotSupportException and MultipleIdNotSupportException
- Enhance annotation documentation for CosId with detailed usage instructions
- Improve documentation for various ID converter implementations
- Add new registry and scanner components with complete JavaDoc coverage
@Ahoo-Wang Ahoo-Wang added documentation Improvements or additions to documentation enhancement New feature or request labels Apr 13, 2026
@Ahoo-Wang Ahoo-Wang changed the title docs(accessor): enhance documentation and add core interfaces docs(core): enhance documentation and add core interfaces Apr 13, 2026
@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 13, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 85.37%. Comparing base (b514bd5) to head (940bed7).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@             Coverage Diff              @@
##               main    #1011      +/-   ##
============================================
+ Coverage     85.32%   85.37%   +0.04%     
- Complexity     1328     1329       +1     
============================================
  Files           214      214              
  Lines          4191     4191              
  Branches        413      413              
============================================
+ Hits           3576     3578       +2     
+ Misses          341      340       -1     
+ Partials        274      273       -1     
Flag Coverage Δ
unittests 85.37% <ø> (+0.04%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@Ahoo-Wang Ahoo-Wang merged commit 2e3c1ce into main Apr 13, 2026
24 checks passed
@Ahoo-Wang Ahoo-Wang deleted the comments branch April 13, 2026 06:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant