-
Notifications
You must be signed in to change notification settings - Fork 0
Open
Description
Description:
Many public APIs lack proper KDoc documentation, making the codebase harder to understand and maintain.
Missing Documentation Areas:
- Public class constructors
- Public method parameters and return values
- Manager classes and their lifecycle
- Extension functions
- Data classes and their properties
Impact:
- Poor developer experience for team members
- Unclear API contracts
- Harder onboarding for new developers
Fix Instructions:
Add comprehensive KDoc for all public APIs:
/**
* Manages Cashu wallet operations and database connections.
*
* This singleton class handles:
* - MultiMintWallet initialization
* - Database lifecycle management
* - Mint configuration changes
*
* @property appContext The application context for database access
* @see MultiMintWallet
*/
object CashuWalletManager {
/**
* Initializes the wallet manager with the given context.
* Safe to call multiple times.
*
* @param context The application context
* @throws IllegalStateException if initialization fails
*/
fun init(context: Context) { ... }
}Priority Areas:
- CashuWalletManager - wallet operations
- PosUiCoordinator - UI coordination
- Payment-related classes
- Manager classes
Tools: Use Android Studio's "Generate Documentation" feature
Metadata
Metadata
Assignees
Labels
No labels