Skip to content

refactor(docs): standardize Javadoc across API and improve internal documentation#13

Merged
devspexx merged 6 commits into
masterfrom
improvement/config-reload-safety
Apr 5, 2026
Merged

refactor(docs): standardize Javadoc across API and improve internal documentation#13
devspexx merged 6 commits into
masterfrom
improvement/config-reload-safety

Conversation

@devspexx

@devspexx devspexx commented Apr 5, 2026

Copy link
Copy Markdown
Owner
  • Standardized Javadoc across all core API classes to be doclint-compliant
  • Added @since annotations to all public and internal methods
  • Improved method-level documentation with clear behavior and failure descriptions
  • Introduced consistent documentation structure (Behavior, Failure Conditions, Threading where applicable)
  • Added detailed inline comments for complex logic (watcher, checksum, loading flow)
  • Clarified API contracts and guarantees (immutability, non-null returns, event behavior)
  • Improved readability and consistency across:
    • ConfigManager
    • GlobalConfigWatcher
    • YamlConfig
    • ConfigLoadResult / ConfigLoadStatus
    • FileChecksum
    • ConfigReloadedEvent
    • ConfigurationAPI bootstrap

No functional changes. Documentation and clarity improvements only.

@devspexx devspexx changed the title Improvement/config reload safety refactor(docs): standardize Javadoc across API and improve internal documentation Apr 5, 2026
@devspexx devspexx merged commit 820a36c into master Apr 5, 2026
@devspexx devspexx deleted the improvement/config-reload-safety branch April 5, 2026 12:36
@devspexx devspexx added Documentation Improvements or additions to documentation, comments, or examples. Enhancement An improvement to existing functionality without changing its core behavior. labels Apr 5, 2026
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, comments, or examples. Enhancement An improvement to existing functionality without changing its core behavior.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant