Skip to content

Readability improvement Refactor -> Added comments to files in /app#613

Open
NathanGr33n wants to merge 12 commits intoclementwzk:mainfrom
NathanGr33n:ReadabilityImprovements
Open

Readability improvement Refactor -> Added comments to files in /app#613
NathanGr33n wants to merge 12 commits intoclementwzk:mainfrom
NathanGr33n:ReadabilityImprovements

Conversation

@NathanGr33n
Copy link

Left existing code mainly unchanged. Added comments to help views understand the functionality and purpose behind most of the code within various .kt and .xml files in /app.

…Themes.kt: Added comments for Improved Readability
Files changed:
- xml/locales_config.xml: Added header comment explaining locale configuration purpose and organized locale entries into regional sections (Middle Eastern/South Asian, European, East Asian, Other) with inline comments for each language
- xml/root_preferences.xml: Added comments for each preference category (General, Formatting, History, Advanced) and individual preference items explaining their functionality
Files changed:
- ExpressionUnitTest.kt: Added comprehensive class-level documentation explaining test scope, added KDoc comments for each test method describing what functionality is being tested, and added comments for helper methods and test fixtures
- NumberFormatterTest.kt: Added class-level documentation explaining number formatting test coverage for International and Indian numbering systems, added KDoc comments for setup method and section comment for Indian numbering system tests
Files changed:
- build.gradle.kts: Added comprehensive comments explaining plugins, Android configuration (SDK versions, build types, resource configurations), Java/Kotlin compiler settings, and all project dependencies organized by category (AndroidX core, UI, architecture, testing)
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