Skip to content

Update documentation and add KDoc to public APIs#43

Merged
linroid merged 1 commit intomainfrom
docs/update-documentation-and-kdoc
Feb 11, 2026
Merged

Update documentation and add KDoc to public APIs#43
linroid merged 1 commit intomainfrom
docs/update-documentation-and-kdoc

Conversation

@linroid
Copy link
Owner

@linroid linroid commented Feb 11, 2026

Summary

  • CLAUDE.md: Complete rewrite to reflect the api+core+remote module architecture, updated package structure, new features (queue management, scheduling, speed limits, download sources, daemon server, remote backend), corrected platform limitations (WasmJs FileAccessor stub, iOS targets, SQLite no WasmJs)
  • README.md: Comprehensive update with corrected badges (Kotlin 2.3.10, Android 26+), modern code examples, full module table with published SDK clarification, platform support matrix (WasmJs "Remote only" footnote), daemon server section, and all new feature documentation
  • KDoc: Added comprehensive documentation to 10 public API files across api, core, and ktor modules (DownloadState, DownloadProgress, KDownError, Segment, KDownVersion, DownloadTask methods, HttpEngine, ServerInfo, FileAccessor, KtorHttpEngine)

Files changed (12)

  • .claude/CLAUDE.md — Full rewrite
  • README.md — Full rewrite
  • library/api/ — KDoc added to 6 files (DownloadState, DownloadProgress, KDownError, Segment, KDownVersion, DownloadTask)
  • library/core/ — KDoc added to 3 files (HttpEngine, ServerInfo, FileAccessor)
  • library/ktor/ — KDoc added to KtorHttpEngine

Test plan

  • ./gradlew :library:api:compileKotlinJvm :library:core:compileKotlinJvm :library:ktor:compileKotlinJvm passes
  • All code examples in README verified against actual API signatures
  • Cross-reference consistency checked between README.md, CLAUDE.md, and LOGGING.md
  • Platform support claims verified against build files

🤖 Generated with Claude Code

Rewrite CLAUDE.md and README.md to reflect the current api+core+remote
module architecture, new features (queue management, scheduling, speed
limits, download sources, daemon server), and corrected platform details.
Add comprehensive KDoc to all public API classes missing documentation.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@linroid linroid merged commit 9d54c7d into main Feb 11, 2026
5 checks passed
@linroid linroid deleted the docs/update-documentation-and-kdoc branch February 11, 2026 16:20
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