Skip to content

Fix \param names that do not match the declaration - #67239

Merged
3nids merged 1 commit into
qgis:masterfrom
darkdi:doc-param-names
Sep 1, 2026
Merged

3nids merged 1 commit into
qgis:masterfrom
darkdi:doc-param-names

Conversation

@darkdi

@darkdi darkdi commented Sep 1, 2026

Copy link
Copy Markdown
Contributor

Description

Ran doxygen over src and six \param names came back with nothing matching them in the declaration below. Most are an argument that got renamed while the comment stayed put, and useheaders against useheader plus category against cat are off by a letter or two. Doxygen drops a name it cannot match without saying anything, so the argument quietly ends up undocumented on the API page while the build stays green. I left out the hits where the argument list carries SIP_OUT or SIP_TRANSFER, my reader mangles those, and the ones where the documented parameter is gone from the signature altogether, since removing a line there is someone else's call.

AI tool usage

  • AI tool(s) (Copilot, Claude, or something similar) supported my development of this PR. See our policy about AI tool use. Use of AI tools must be indicated. Failure to be honest might result in banning.

Claude Code (claude-opus-5) found the mismatches and drafted this text. Every one of the six was checked by hand against the declaration under it.

@github-actions github-actions Bot added this to the 4.4.0 milestone Sep 1, 2026
@github-actions github-actions Bot added Labeling Related to QGIS map labeling GRASS Digitizing Related to feature digitizing map tools or functionality Mesh Related to general mesh layer handling (not specific data formats) labels Sep 1, 2026
@nicogodet

Copy link
Copy Markdown
Member

It misses pre-commit checks (sip) ?

@darkdi

darkdi commented Sep 1, 2026

Copy link
Copy Markdown
Contributor Author

None of the six are sipified. Five sit under src/app and src/providers, which have no bindings at all, and qgsmeshcalcnode.h is inside a ///@cond PRIVATE block with no sip.in under python/PyQt6/core/auto_generated/mesh. So there should be nothing for sipify to regenerate here.

@3nids
3nids merged commit af4f7c9 into qgis:master Sep 1, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Digitizing Related to feature digitizing map tools or functionality GRASS Labeling Related to QGIS map labeling Mesh Related to general mesh layer handling (not specific data formats)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants