Skip to content

docs: add comprehensive JSDoc documentation to all Python modules #23

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

Ain477
Copy link

@Ain477 Ain477 commented Jun 19, 2025

  • 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

- 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
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