Fix \param names in interp_get_base and riscv_timer_set_mtimecmp #3165

Merged

darkdi merged 1 commit from doc-param-names into develop

2026-09-01 11:20:19 -05:00

darkdi commented

2026-09-01 02:11:06 -05:00

(Migrated from github.com)

Was checking doxygen output on the interp and riscv timer headers and hit two \param names that don't match the argument below them. interp_get_base documents lane, which looks copied from interp_set_base just above it, and riscv_timer_set_mtimecmp documents mtime from its neighbour. Doxygen drops unmatched names quietly so the build stays green either way. I left the mtimecmp wording alone, it still reads as if the call sets mtime and that seemed like your call.

Was checking doxygen output on the interp and riscv timer headers and hit two \param names that don't match the argument below them. interp_get_base documents `lane`, which looks copied from interp_set_base just above it, and riscv_timer_set_mtimecmp documents `mtime` from its neighbour. Doxygen drops unmatched names quietly so the build stays green either way. I left the mtimecmp wording alone, it still reads as if the call sets mtime and that seemed like your call.

lurch (Migrated from github.com) approved these changes

2026-09-01 05:28:41 -05:00

lurch commented

2026-09-01 05:29:43 -05:00

(Migrated from github.com)

Doxygen drops unmatched names quietly

Well that's a bit annoying 🙁

> Doxygen drops unmatched names quietly Well that's a bit annoying :slightly_frowning_face:

darkdi commented

2026-09-01 05:58:18 -05:00

(Migrated from github.com)

I was wrong about that. It does warn, I just checked with 1.18 against the defaults docs/Doxyfile.in inherits:

t.h:2: warning: argument 'lane' of command @param is not found in the argument list of interp_get_base(void *interp, unsigned index)
t.h:2: warning: The following parameter of interp_get_base(void *interp, unsigned index) is not documented:
  parameter 'index'

Both of those, and then it exits 0. So the docs job stays green and the two lines scroll past with everything else. WARN_AS_ERROR = FAIL_ON_WARNINGS in docs/Doxyfile.in would catch the next one without changing how much output you get, it runs the whole build and only sets the exit code at the end.

I was wrong about that. It does warn, I just checked with 1.18 against the defaults `docs/Doxyfile.in` inherits: ``` t.h:2: warning: argument 'lane' of command @param is not found in the argument list of interp_get_base(void *interp, unsigned index) t.h:2: warning: The following parameter of interp_get_base(void *interp, unsigned index) is not documented: parameter 'index' ``` Both of those, and then it exits 0. So the docs job stays green and the two lines scroll past with everything else. `WARN_AS_ERROR = FAIL_ON_WARNINGS` in `docs/Doxyfile.in` would catch the next one without changing how much output you get, it runs the whole build and only sets the exit code at the end.