GTK3V2MAIN CI (docs-doxygen target, docs/doxygen/Doxyfile.in) started failing 2026-09-08 after
Martin Fischer's Hg rev 7227 "Add missing to subdirectories to doxygen-docs build" widened the
internal-API-docs INPUT set to include app/bin/appmainwindow, app/bin/form, and app/bin/parts for
the first time (previously only app/bin's top-level files, app/wlib, app/dynstring, app/bin/cars
were scanned). WARN_AS_ERROR = FAIL_ON_WARNINGS in that Doxyfile.in means any warning is now a
hard build failure, and these newly-scanned directories carry pre-existing doc-comment gaps that
were simply never checked before.
Confirmed by reproducing locally (doxygen 1.15.0 and 1.16.1 both fail identically; CI job
"doxygen" / target docs-doxygen). Full doxygen.log content:
app/bin/form/dialog.c:2: error: the name 'dialogs.c' supplied as the argument in the \file
statement is not an input file
app/bin/form/formatdistance.c:2: error: the name 'formdistance.c' supplied as the argument in the
\file statement is not an input file
app/bin/form/loadcontrols.c:2: error: the name 'loadcontrol.c' supplied as the argument in the
\file statement is not an input file
app/bin/form/macro.c:2: error: the name 'formmacro.c' supplied as the argument in the \file
statement is not an input file
app/bin/form/fetchdata.c:145: error: Found unknown command '\TODO'
app/bin/appmainwindow/toolbar.c:147: error: argument 'unused' of command @param is not found in
the argument list of InitializeToolbarDialog(void)
app/bin/appmainwindow/toolbar.c:265: error: argument 'inx' of command @param is not found in the
argument list of IsButtonVisible(int group, long mode, long options, long layerButtons)
app/bin/appmainwindow/toolbar.c:265: error: The following parameters of IsButtonVisible(int
group, long mode, long options, long layerButtons) are not documented: parameter 'group',
parameter 'mode', parameter 'options', parameter 'layerButtons'
app/bin/appmainwindow/toolbar.c:513: error: argument 'buttInx' of command @param is not found in
the argument list of PlaybackButtonMouse(wIndex_t buttonInx)
app/bin/appmainwindow/toolbar.c:513: error: The following parameter of
PlaybackButtonMouse(wIndex_t buttonInx) is not documented: parameter 'buttonInx'
app/bin/appmainwindow/toolbar.c:469: error: found documented return type for
ToolbarButtonCommandLink that does not return anything
app/bin/appmainwindow/toolbar.c:284: error: The following parameter of
ToolbarButtonPlace(struct sToolbarState tbState, wIndex_t inx) is not documented: parameter
'tbState'
app/bin/appmainwindow/toolbar.c:426: error: The following parameter of
ToolbarControlAdd(wControl_p control, long options, int cmdGroup) is not documented: parameter
'cmdGroup'
app/bin/form/checkinputs.c:55: error: argument 'data' of command @param is not found in the
argument list of FormErrorState(paramData_p p, wBool_t valid, const char reason)
app/bin/form/checkinputs.c:55: error: The following parameter of FormErrorState(paramData_p p,
wBool_t valid, const char *reason) is not documented: parameter 'p'
app/bin/form/loadcontrols.c:167: error: argument 'pointer' of command @param is not found in the
argument list of FormLoadControls(paramGroup_p pg)
app/bin/form/loadcontrols.c:167: error: The following parameter of FormLoadControls(paramGroup_p
pg) is not documented: parameter 'pg'
Two categories: (1) 4 stale \file names (the file was renamed at some point since the \file
comment was written but the comment wasn't updated) and one unknown \TODO command; (2) genuine
@param/documentation mismatches in toolbar.c/checkinputs.c/loadcontrols.c predating this change.
Fix is a straightforward doc-comment triage pass over the newly-included files, matching the
pattern already used for bug #653/#654/#655 (the original app/bin doxygen triage) -- no code
behavior changes needed, just doc comments. app/bin/appmainwindow and app/bin/parts should also be
spot-checked beyond just these errors since only the first failure per file stops doxygen's error
accumulation in some cases.
Not related to and not fixed by the concurrently-merged #781/#784/#785 bug fixes -- confirmed via
git diff that none of those touch app/bin/form/, app/bin/appmainwindow/, or Doxyfile.in's INPUT
list.
Anonymous