killingdruid/telegram-tui
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: add rustdoc comments for public API (P4.12 partial)

Browse Source 
- Add comprehensive documentation for TdClient:
  * Struct-level docs with examples
  * Authentication methods (send_phone_number, send_code, send_password)
  * Chat methods (load_chats, load_folder_chats, leave_chat, get_profile_info)
  * All methods now have parameter docs, return types, and error descriptions

- Add comprehensive documentation for App:
  * Struct-level docs with state machine explanation
  * Constructor documentation
  * Examples for common usage patterns

- Progress: +60 doc comment lines (210 → 270)
- Update REFACTORING_ROADMAP.md (P4.12 partial completion)

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
This commit is contained in:
Mikhail Kilin
2026-01-31 23:53:24 +03:00
parent 1629c0fc6a
commit 6cc8d05e1c
3 changed files with 170 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
REFACTORING_ROADMAP.md
View File

@@ -554,11 +554,13 @@ fn test_message_grouping_by_date() {
---
### 12. Добавить rustdoc комментарии
### 12. Добавить rustdoc комментарии ✅ В ПРОЦЕССЕ...
**Статус**: ЧАСТИЧНО ЗАВЕРШЕНО (+60 doc-комментариев, 2026-01-31)
**Проблема**: Публичное API не документировано.
**Решение**: Добавить doc-комментарии:
**Решение**: ✅ Добавлены doc-комментарии для ключевых модулей:
```rust
/// TDLib client wrapper for Telegram integration.
///