GBALATRO/balatro-gba

Document Project With Doxygen

Open

#296 opened on Dec 11, 2025

View on GitHub
 (0 comments) (0 reactions) (0 assignees)C (2,281 stars) (95 forks)auto 404
documentationgood first issue

Description

All files (within reason) should be properly documented with Doxygen. This task will need to be split into smaller subtasks per file, for anyone willing to take it on and not be overwhelmed.

Examples of documented files are bitset.h and list.h

Contributor guide

Tech stack
c
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
GitC
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85
Research direction
Read the existing documented files (bitset.h and list.h) as examples, then add Doxygen style comments to undocumented header files.