{"id":135,"date":"2022-10-17T11:17:11","date_gmt":"2022-10-17T10:17:11","guid":{"rendered":"https:\/\/mrzebra.co.uk\/code\/?p=135"},"modified":"2022-10-17T11:17:11","modified_gmt":"2022-10-17T10:17:11","slug":"how-to-show-doxygen-errors-in-vscodes-problems-panel","status":"publish","type":"post","link":"https:\/\/zebra-north.com\/code\/2022\/10\/17\/how-to-show-doxygen-errors-in-vscodes-problems-panel\/","title":{"rendered":"How to show Doxygen errors in VSCode’s “Problems” panel"},"content":{"rendered":"\n

If you’re using Doxygen to generate your project’s documentation, it would be nice to see errors in Visual Studio Code’s “Problems” panel so you can assess them and jump directly to them in the source code.<\/p>\n\n\n

\n
\"\"<\/figure><\/div>\n\n\n\n\n\n\n

This can be achieved by creating a build task to run Doxygen, and a custom problem matcher to gather the errors.<\/p>\n\n\n\n

Add a new task to VSCode’s tasks.json<\/code> file. If the file does not exist, create it in the “.vscode” directory.<\/p>\n\n\n\n

{\n\t"version": "2.0.0",\n\t"tasks": [\n\t\t{\n\t\t\t"type": "process",\n\t\t\t"label": "Build documentation",\n\t\t\t"command": "doxygen",\n\t\t\t"group": "build",\n\t\t\t"problemMatcher": [\n\t\t\t\t{\n\t\t\t\t\t"owner": "cpp",\n\t\t\t\t\t"fileLocation": "absolute",\n\t\t\t\t\t"pattern": {\n\t\t\t\t\t\t"regexp": "^([^:]+):(\\\\d+): (error|warning): (.*?)( \\\\(warning treated as error, aborting now\\\\))?$",\n\t\t\t\t\t\t"file": 1,\n\t\t\t\t\t\t"line": 2,\n\t\t\t\t\t\t"severity": 3,\n\t\t\t\t\t\t"message": 4\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t],\n\t\t\t"detail": "Build documentation"\n\t\t}\n    ]\n}<\/code><\/pre>\n\n\n\n
You can run the task from the toolbar by selecting “Tasks: Run Task” and choosing “Build documentation”.<\/p>\n","protected":false},"excerpt":{"rendered":"
If you’re using Doxygen to generate your project’s documentation, it would be nice to see errors in Visual Studio Code’s “Problems” panel so you can assess them and jump directly to them in the source code.<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[4],"tags":[17],"class_list":["post-135","post","type-post","status-publish","format-standard","hentry","category-cpp","tag-vscode"],"_links":{"self":[{"href":"https:\/\/zebra-north.com\/code\/wp-json\/wp\/v2\/posts\/135","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/zebra-north.com\/code\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/zebra-north.com\/code\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/zebra-north.com\/code\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/zebra-north.com\/code\/wp-json\/wp\/v2\/comments?post=135"}],"version-history":[{"count":1,"href":"https:\/\/zebra-north.com\/code\/wp-json\/wp\/v2\/posts\/135\/revisions"}],"predecessor-version":[{"id":137,"href":"https:\/\/zebra-north.com\/code\/wp-json\/wp\/v2\/posts\/135\/revisions\/137"}],"wp:attachment":[{"href":"https:\/\/zebra-north.com\/code\/wp-json\/wp\/v2\/media?parent=135"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/zebra-north.com\/code\/wp-json\/wp\/v2\/categories?post=135"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/zebra-north.com\/code\/wp-json\/wp\/v2\/tags?post=135"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}