docs: Complete the architecture documentation - #1
Open
uditmital-netizen wants to merge 2 commits into
Open
Conversation
This commit adds the full docs/ tree for the Wolfenstein 3-D source code reference. It was generated by reading the 1992 source in WOLFSRC/ at revision 0516778. New reference indexes (previously advertised but missing): - docs/reference/functions.md — every public function by file, with signature, source line, and one-line role. - docs/reference/constants.md — #define, enum, and .EQU constants grouped by 14 semantic families (limits, trig, tiles, scancodes, VGA registers, audio, paging, actor enums, etc.). Fixes to existing per-file notes: - docs/files/WL_DRAW.md: replaced ??? line numbers for ThreeDRefresh (1336) and PlayLoop (1368). - docs/files/WL_MAIN.md: corrected Scores[7] location to ID_US_1.C:57 (was WL_MAIN.C:???). - docs/files/WL_DRAW.md: removed a stray non-ASCII character. All previously dangling reference/ links now resolve. Co-Authored-By: Claude <noreply@anthropic.com>
Fixes from review: - ARCHITECTURE.md §6: corrected FINEANGLES from 28800 to 3600 (the source defines FINEANGLES=3600 in WL_DEF.H:105). - reference/constants.md: corrected DOORWALL (WL_DRAW.C:19, was :22) and ACTORSIZE (WL_DRAW.C:21, was :26). - files/WL_DRAW.md: same DOORWALL/ACTORSIZE line number corrections. Co-Authored-By: Claude <noreply@anthropic.com>
Author
Code review findingsReviewed the full Issues found
Verification summary
Fixes applied in follow-up commit Overall: the docs are accurate, well-structured, and the cross-references are solid. LGTM after the fixes. |
| | `TILESHIFT` | `16` | Right-shift to convert fixed→tile integer coordinate | | ||
| | `FOCALLENGTH` | `0x5700l` | Default focal length (~320 fixed units) | | ||
| | `ANGLES` | `360` | Full turn divided into 360 fixed angles | | ||
| | `FINEANGLES`| `ANGLES*80`=28800| Sub-resolution for cosine/sine LUTs | |
Author
There was a problem hiding this comment.
Factual error: FINEANGLES is claimed as 28800 (ANGLES*80), but WL_DEF.H:105 defines it as 3600.
Fixed in follow-up commit 778abe0.
| | `stat_t` enum | `WL_DEF.H` | Static pickup types | | ||
| | `dirtype` enum | `WL_DEF.H` | 9 facing directions | | ||
| | `ACTORSIZE` | `0x4000` | `WL_DRAW.C:26` | Actor collision radius (fixed) | | ||
| | `DOORWALL` | `PMSpriteStart-8` | `WL_DRAW.C:22` | Door-wall chunk base | |
Author
There was a problem hiding this comment.
Line number error: DOORWALL is at WL_DRAW.C:19, not :22. Same error in files/WL_DRAW.md (line 65).
Fixed in follow-up commit 778abe0.
| | `enemy_t` enum | `WL_DEF.H` | 22 enemy classes (`NUMENEMIES=22`) | | ||
| | `stat_t` enum | `WL_DEF.H` | Static pickup types | | ||
| | `dirtype` enum | `WL_DEF.H` | 9 facing directions | | ||
| | `ACTORSIZE` | `0x4000` | `WL_DRAW.C:26` | Actor collision radius (fixed) | |
Author
There was a problem hiding this comment.
Line number error: ACTORSIZE is at WL_DRAW.C:21, not :26. Same error in files/WL_DRAW.md (line 66).
Fixed in follow-up commit 778abe0.
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.
This PR adds the full
docs/reference tree for the Wolfenstein 3-Dsource code. All content was generated by reading the 1992 source in
WOLFSRC/at revision0516778.New reference indexes (previously advertised but missing):
docs/reference/functions.md— every public function by file, withsignature, source line, and one-line role (591 functions).
docs/reference/constants.md—#define,enum, and.EQUconstants grouped by 14 semantic families (1000+ symbols).
Fixes to existing notes:
files/WL_DRAW.md: correctedThreeDRefresh(line 1336) andPlayLoop(line 1368) line numbers.files/WL_MAIN.md: fixedScores[7]location toID_US_1.C:57.files/WL_DRAW.md: removed a stray non-ASCII character.All previously dangling
reference/links now resolve.🤖 Generated with Claude Code