docs: improve JSDoc/TypeDoc documentation — remove inline comments, add missing public API docs#1919
Merged
Merged
Conversation
- Remove all @public JSDoc tags from src/types/ and src/utils/ - Remove standalone/EOL inline comments from function bodies - Convert top-level // comments to proper JSDoc blocks in constants files - Expand JSDoc on effectUtils.ts exported functions with @param/@returns/@category/@korean - Clean // Fix: stub comments from constants/index.ts barrel No logic changes. TypeScript check: 0 errors.
…and deviceDetection
…nts, safeAreaUtils
…cFeedback, responsiveLayoutHelpers
…ng, mobileLayoutHelpers, mobileUIUtils
Contributor
Dependency Review✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.Scanned FilesNone |
Contributor
🎯 Accessibility Test ResultsWCAG 2.1 Level AA Compliance Tests
Components Tested
Test Framework
|
Contributor
📸 Automated UI Screenshots📋 Screenshots Captured (8)
📦 Download Screenshots📥 Download all screenshots from workflow artifacts
🤖 Generated by Playwright automation |
Copilot stopped work on behalf of
pethers due to an error
May 11, 2026 19:58
Copilot created this pull request from a session on behalf of
pethers
May 11, 2026 19:58
View session
- Remove redundant comments that restate what code obviously does across CombatSystem.ts, EffectCalculator.ts, VitalPointSystem.ts, LayoutSystem.ts, PlayerEffectManager.ts, and sub-system files - Preserve WHY-explaining comments, Korean-language comments, math formula explanations, and architectural rationale - Upgrade bare // comments in game.ts to proper JSDoc blocks with @module, @category, and per-interface descriptions - Replace doubled comments before enums in effects.ts with single JSDoc /** */ doc-comments - Improve module-level JSDoc in types.ts and index.ts (remove auto-generated notice, add meaningful descriptions) Co-authored-by: pethers <1726836+pethers@users.noreply.github.com>
- Fix '맸통' → '몸통' (torso) in physicalAttributeValidation.ts - Fix '쳌둥벽력' → '천둥벽력' (Thunder Strike) in technique.ts - Fix '팔괴' → '팔괘' (Eight Trigrams) in controlMapping.ts and player-visual.ts - Fix '공' → '곤' (Gon/Earth trigram) comment in player-visual.ts - Fix '출혁' → '출혈' (blood loss) in player-visual.ts (two occurrences) - Fix '머향하기상태/콜백' → '몸향하기상태/콜백' in player-visual.ts - Fix '뉕3D속성' → '눈3D속성' (eye props) in facial.ts - Fix '섈3D속성' → '입3D속성' (mouth props) in facial.ts - Fix '펼기' → '펴기' (open hand) in hand-animation.ts (two occurrences) - Fix '무술출캘' → '무술출처' (martial art origin) in hand-animation.ts - Fix '부착뉴' → '부착뼈' (attached bones) in clothing.ts - Fix '뉴맵' → '뼈맵' (bone map) in clothing.ts - Fix '흥괴' → '흑괘' (Black Trigram) in PhysicsTypes.ts - Fix 'colour' → 'color' in ui.ts (four occurrences) Co-authored-by: pethers <1726836+pethers@users.noreply.github.com>
Contributor
🎯 Accessibility Test ResultsWCAG 2.1 Level AA Compliance Tests
Components Tested
Test Framework
|
Contributor
📸 Automated UI Screenshots📋 Screenshots Captured (8)
📦 Download Screenshots📥 Download all screenshots from workflow artifacts
🤖 Generated by Playwright automation |
- Add class-level JSDoc to AudioManager with @example and @korean tags - Remove redundant inline comments restating obvious code behavior - Remove stale dev-note '// Fix:' comment in crossfade method - Replace '// Additional methods' / '// New optimized methods' section markers with proper method-level JSDoc where absent - Remove auto-generated filepath comment from index.ts - Remove redundant '// Re-export types that were missing' comment - Add getter JSDoc to isInitialized property Co-authored-by: pethers <1726836+pethers@users.noreply.github.com>
Contributor
🎯 Accessibility Test ResultsWCAG 2.1 Level AA Compliance Tests
Components Tested
Test Framework
|
1 similar comment
Contributor
🎯 Accessibility Test ResultsWCAG 2.1 Level AA Compliance Tests
Components Tested
Test Framework
|
Contributor
📸 Automated UI Screenshots📋 Screenshots Captured (8)
📦 Download Screenshots📥 Download all screenshots from workflow artifacts
🤖 Generated by Playwright automation |
Contributor
🎯 Accessibility Test ResultsWCAG 2.1 Level AA Compliance Tests
Components Tested
Test Framework
|
Contributor
📸 Automated UI Screenshots📋 Screenshots Captured (8)
📦 Download Screenshots📥 Download all screenshots from workflow artifacts
🤖 Generated by Playwright automation |
Co-authored-by: pethers <1726836+pethers@users.noreply.github.com>
Contributor
🎯 Accessibility Test ResultsWCAG 2.1 Level AA Compliance Tests
Components Tested
Test Framework
|
github-actions
Bot
added
graphics
…aned) Agent-Logs-Url: https://github.com/Hack23/blacktrigram/sessions/80a82719-26e4-4002-bea7-3ceff01cd636 Co-authored-by: pethers <1726836+pethers@users.noreply.github.com>
Contributor
🎯 Accessibility Test ResultsWCAG 2.1 Level AA Compliance Tests
Components Tested
Test Framework
|
Contributor
📸 Automated UI Screenshots📋 Screenshots Captured (8)
📦 Download Screenshots📥 Download all screenshots from workflow artifacts
🤖 Generated by Playwright automation |
…izer Agent-Logs-Url: https://github.com/Hack23/blacktrigram/sessions/80a82719-26e4-4002-bea7-3ceff01cd636 Co-authored-by: pethers <1726836+pethers@users.noreply.github.com>
Contributor
📸 Automated UI Screenshots📋 Screenshots Captured (8)
📦 Download Screenshots📥 Download all screenshots from workflow artifacts
🤖 Generated by Playwright automation |
Contributor
🎯 Accessibility Test ResultsWCAG 2.1 Level AA Compliance Tests
Components Tested
Test Framework
|
1 similar comment
Contributor
🎯 Accessibility Test ResultsWCAG 2.1 Level AA Compliance Tests
Components Tested
Test Framework
|
Contributor
📸 Automated UI Screenshots📋 Screenshots Captured (8)
📦 Download Screenshots📥 Download all screenshots from workflow artifacts
🤖 Generated by Playwright automation |
Contributor
📸 Automated UI Screenshots📋 Screenshots Captured (8)
📦 Download Screenshots📥 Download all screenshots from workflow artifacts
🤖 Generated by Playwright automation |
Contributor
📸 Automated UI Screenshots📋 Screenshots Captured (8)
📦 Download Screenshots📥 Download all screenshots from workflow artifacts
🤖 Generated by Playwright automation |
Copilot stopped work on behalf of
pethers due to an error
May 11, 2026 21:01
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
@publictags (redundant in TypeDoc) across all type filessrc/types/(constants, colors, ui, typography, index)src/utils/(deviceDetection, effectUtils, physicalAttributeValidation, player3DHelpers, math, haptics, etc.)