Skip to content

Add comprehensive KDoc documentation to public APIs#342

Merged
MrHadiSatrio merged 10 commits intodevelopfrom
claude/document-lib-kmm-api-WmEXh
Feb 24, 2026
Merged

Add comprehensive KDoc documentation to public APIs#342
MrHadiSatrio merged 10 commits intodevelopfrom
claude/document-lib-kmm-api-WmEXh

Conversation

@MrHadiSatrio
Copy link
Owner

What has changed?

Added KDoc documentation to all public classes, interfaces, functions, and properties across the codebase. This includes:

  • Core abstractions: Event, EventSource, EventSink, Presenter, UseCase, Adapter, Predicate, Decor
  • Event types: CompletionEvent, SelectionEvent, TextInputEvent, CancellationEvent, PerfSensitiveEvent, ExceptionalEvent
  • Geography APIs: Place, Places, Coordinates, Distance, Speed, and various implementations
  • Collection utilities: PagingIterator, ExceptionCatchingIterable, IteratorIterable
  • Android widgets: RecyclerViewPresenter, ListViewPresenter, ViewFactory, ViewRenderer, ItemDiffer
  • Modal and presentation: Modal, BinaryConfirmationModal, ModalApprovalEvent, ModalDismissalEvent
  • Event sources and sinks: Various implementations like DebouncingEventSource, SchedulingEventSource, FilteringEventSink, etc.
  • I/O and file handling: JsonFile, Sources, FileSystemSources, SchemeWiseSources
  • Android-specific: CurrentActivity, PermissionAwareCoordinates, LocationManagerCoordinates, GmsCoordinates, etc.

Documentation includes:

  • Class/interface purpose and behavior
  • Parameter descriptions with @param tags
  • Return value descriptions with @return tags
  • Notable constraints, exceptions, and side effects
  • Property documentation for key fields

Why it was changed?

Comprehensive API documentation improves developer experience by:

  • Making the purpose and usage of each public API immediately clear
  • Reducing the need to read implementation code to understand behavior
  • Enabling IDE tooltips and autocomplete hints
  • Facilitating better code navigation and discoverability
  • Establishing a foundation for generated API documentation

This is a documentation-only change with no impact on runtime behavior or functionality.

https://claude.ai/code/session_018vxGCBFVUCrx1vEQP8WmPN

Copy link
Owner Author

@MrHadiSatrio MrHadiSatrio left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please address my feedback. Also, check is apparently failing.

@MrHadiSatrio MrHadiSatrio force-pushed the claude/document-lib-kmm-api-WmEXh branch from 1926a9c to e870830 Compare February 22, 2026 06:20
@MrHadiSatrio MrHadiSatrio force-pushed the claude/document-lib-kmm-api-WmEXh branch from 9684f66 to 921d8e1 Compare February 23, 2026 23:58
@MrHadiSatrio MrHadiSatrio force-pushed the claude/document-lib-kmm-api-WmEXh branch from 921d8e1 to a9e53f6 Compare February 24, 2026 00:09
MrHadiSatrio and others added 3 commits February 24, 2026 07:28
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@MrHadiSatrio MrHadiSatrio force-pushed the claude/document-lib-kmm-api-WmEXh branch from a9e53f6 to c74c057 Compare February 24, 2026 00:28
@sonarqubecloud
Copy link

@MrHadiSatrio MrHadiSatrio merged commit 1fd7f32 into develop Feb 24, 2026
3 checks passed
@MrHadiSatrio MrHadiSatrio deleted the claude/document-lib-kmm-api-WmEXh branch February 24, 2026 01:26
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.

2 participants