docs: add comprehensive JSDoc documentation to all Python modules#23
Open
Ain477 wants to merge 1 commit intohijam-git:mainfrom
Open
docs: add comprehensive JSDoc documentation to all Python modules#23Ain477 wants to merge 1 commit intohijam-git:mainfrom
Ain477 wants to merge 1 commit intohijam-git:mainfrom
Conversation
- Add module docstrings with author, version, and description to all 11 Python files - Document all classes with inheritance information and method details - Add function docstrings with parameter types, return values, and exceptions - Include @param, @returns, @throws, @extends, @author, @Version, @SInCE tags - Cover main application files: main.py, GetDataV2.py, SetupPordaApp.py - Document settings module: SettingsValue.py, message.py, startup.py, settingscss2.py, doc.py, ga4_porda.py, EngineSetting.py, Settings.py - Improve code maintainability and developer experience - Follow consistent JSDoc-style documentation standards throughout codebase Files modified: - main.py: Add class and method documentation for KeyBoardManager, CPUThread, MainWindow, SystemTrayIcon - GetDataV2.py: Document screen capture and window management functions - SetupPordaApp.py: Document application setup and configuration functions - settings/*.py: Document all settings management, UI, and engine configuration modules
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
1 participant
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.
Files modified: