Page MenuHomePhabricator

Doxygen: Ignore `@phan` notation (and more)
Open, Needs TriagePublic

Description

Doxygen sometimes reads and tries to interpret phan notation; it should ignore it. Specific tags that I have seen

@phan-file-suppress

@phan-var

@phan-param

@phan-return

@return-taint

Event Timeline

Restricted Application added a project: User-DannyS712. · View Herald TranscriptDec 19 2019, 10:58 PM
Restricted Application added subscribers: Liuxinyu970226, Aklapper. · View Herald Transcript

Change 559618 had a related patch set uploaded (by DannyS712; owner: DannyS712):
[mediawiki/core@master] Doxygen: Fix ignoring @phan notation

https://gerrit.wikimedia.org/r/559618

DannyS712 updated the task description. (Show Details)Dec 19 2019, 11:05 PM

Change 559618 merged by jenkins-bot:
[mediawiki/core@master] Doxygen: Fix ignoring @phan notation, also ignore @return-taint

https://gerrit.wikimedia.org/r/559618

Change 563330 had a related patch set uploaded (by DannyS712; owner: DannyS712):
[mediawiki/core@master] Revert "Doxygen: Fix ignoring @phan notation, also ignore @return-taint"

https://gerrit.wikimedia.org/r/563330

DannyS712 removed DannyS712 as the assignee of this task.Jan 10 2020, 3:01 AM
DannyS712 moved this task from Awaiting review and deployment to Reports on the User-DannyS712 board.

Didn't actually fix the issues. I've created a revert, and will leave this for someone else

Change 563330 merged by jenkins-bot:
[mediawiki/core@master] Revert "Doxygen: Fix ignoring @phan notation, also ignore @return-taint"

https://gerrit.wikimedia.org/r/563330

Change 571559 had a related patch set uploaded (by Anomie; owner: Anomie):
[mediawiki/core@master] Improve Doxygen aliases

https://gerrit.wikimedia.org/r/571559

Upstream change: https://github.com/doxygen/doxygen/issues/1413 which has a patch in Doxygen master branch https://github.com/doxygen/doxygen/pull/7264 . That introduces a \noop command to strip all content.

Doxygen 1.8.17 has been released which includes the new @noop tag. Next step: Upgrade Doxygen in WMF CI.

These @phan- tags can also be aliased to @noop which should solve this.