andrew/akbasic
1
0
Fork 0
Code Issues 37 Pull Requests 5 Actions 2 Packages Projects Releases Wiki Activity

Fix Doxygen gate failures on main #60

Merged
andrew merged 1 commits from 56-doxygen-gate-fixes into main 2026-08-06 08:45:38 -04:00
Conversation 0 Commits 1 Files Changed 6 +18 -11
tachikoma commented 2026-08-05 23:48:28 -04:00
Collaborator
Copy Link

Fixes the four independent defects that made the Doxygen documentation gate fail on main (nine reported errors, none introduced by any recent change).

  1. runtime.h: a stacked doc block meant for akbasic_runtime_new_function was left directly above akbasic_runtime_call_function's declaration with nothing in between, so Doxygen glommed both blocks onto call_function and duplicated the @param obj / @param dest entries. Moved the block back to sit directly above new_function's declaration.
  2. sprite.h, akgl.h, sprite_akgl.c: three Doxygen #AKGL_/#AKBASIC_SHAPE_ autolinks referenced libakgl symbols that are outside this Doxyfile's INPUT, so they could never resolve. Converted them to plain code spans.
  3. scanner.c: peek(), peek_next() and match_next_char() were each missing @param entries (obj on the first two; obj, cm, truetype and falsetype on match_next_char). Filled them in.
  4. Doxyfile: the error.h "included by" graph hit DOT_GRAPH_MAX_NODES exactly at the default of 50. Raised the threshold to 100.

Verified doxygen Doxyfile now exits 0 with no warnings/errors, with graphviz installed.

Refs #56

Fixes the four independent defects that made the Doxygen documentation gate fail on main (nine reported errors, none introduced by any recent change). 1. runtime.h: a stacked doc block meant for akbasic_runtime_new_function was left directly above akbasic_runtime_call_function's declaration with nothing in between, so Doxygen glommed both blocks onto call_function and duplicated the @param obj / @param dest entries. Moved the block back to sit directly above new_function's declaration. 2. sprite.h, akgl.h, sprite_akgl.c: three Doxygen #AKGL_*/#AKBASIC_SHAPE_* autolinks referenced libakgl symbols that are outside this Doxyfile's INPUT, so they could never resolve. Converted them to plain code spans. 3. scanner.c: peek(), peek_next() and match_next_char() were each missing @param entries (obj on the first two; obj, cm, truetype and falsetype on match_next_char). Filled them in. 4. Doxyfile: the error.h "included by" graph hit DOT_GRAPH_MAX_NODES exactly at the default of 50. Raised the threshold to 100. Verified `doxygen Doxyfile` now exits 0 with no warnings/errors, with graphviz installed. Refs #56
tachikoma added 1 commit 2026-08-05 23:48:28 -04:00
Fix Doxygen gate failures on main
Some checks failed
akbasic CI Build / cmake_build (push) Failing after 3m41s
Details
akbasic CI Build / sanitizers (push) Failing after 5m59s
Details
akbasic CI Build / coverage (push) Failing after 4m38s
Details
akbasic CI Build / akgl_build (push) Failing after 8m20s
Details
akbasic CI Build / mutation_test (push) Failing after 3m56s
Details
809a9bf64d 
Four independent defects that made 'doxygen Doxyfile' exit 1:

- runtime.h: a stacked doc block above akbasic_runtime_new_function
  was left directly above akbasic_runtime_call_function's declaration
  with no function in between, so Doxygen glommed both blocks onto
  call_function and duplicated the @param obj/@param dest entries.
  Moved the block back to sit directly above new_function.
- sprite.h/akgl.h/sprite_akgl.c: three #AKGL_*/#AKBASIC_SHAPE_* Doxygen
  autolinks pointed at libakgl symbols outside this Doxyfile's INPUT,
  so they could never resolve. Converted them to plain code spans.
- scanner.c: peek(), peek_next() and match_next_char() were each
  missing @param obj (and match_next_char also cm/truetype/falsetype).
  Filled in the missing entries.
- Doxyfile: the error.h include graph hit DOT_GRAPH_MAX_NODES at
  exactly the default of 50. Raised it to 100.

Verified 'doxygen Doxyfile' now exits 0 with graphviz installed.

Refs #56

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
tachikoma requested review from andrew 2026-08-05 23:48:42 -04:00
andrew merged commit cdb9be03c6 into main 2026-08-06 08:45:38 -04:00
Sign in to join this conversation.
Reviewers
No Reviewers
andrew
Labels
Clear labels
abi-break
Cannot land without a soname bump
 api-gap
A caller cannot express something
 blast-radius:high
Ordering: highest blast radius
 blast-radius:low
Ordering: lowest blast radius
 blast-radius:medium
Ordering: middling blast radius
 defect
Wrong behaviour reachable from the public API
 design-decision
Needs a decision written down before code
 docs
Documentation, comments, AGENTS.md
 hygiene
Style, dead code, consistency
 packaging
Build, install, pkg-config, CMake config
 performance
Has a measurement behind it
 status::blocked
Waiting on something else -- a decision, a dependency, or another issue
 status::grooming
Not yet worked out: scope, approach or priority still being settled
 status::ready
Understood well enough to start: scope and approach are settled
 status::review
A pull request has been generated and this ticket is waiting on review of that PR
 test-coverage
A gap in the suites, not a defect
No Label
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
logikoma tachikoma andrew
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: andrew/akbasic#60
Delete Branch "56-doxygen-gate-fixes"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?