betwo / vscode-doxygen-runner

VS Code extension for Doxygen generation and preview
https://marketplace.visualstudio.com/items?itemName=betwo.vscode-doxygen-runner
MIT License
0 stars 2 forks source link

Cannot find Doxyfile #11

Open wpd opened 3 years ago

wpd commented 3 years ago

Sorry for the clueless question, but I just tried installing this extension and running the "Generate Doxygen Documentation" command, but when I do that, I get the following error:

Error while generating Documentation. Cannot find Doxyfile for /home/wpd/src/ble2ros.

I generated a Doxyfile with doxygen -g, and I can see that it exists:

$ ls -l /home/wpd/src/ble2ros/Doxyfile
-rw-rw-r-- 1 wpd wpd 112571 Jun 21 17:28 /home/wpd/src/ble2ros/Doxyfile

What am I missing? VSCode 1.57.1 Doxygen Runner 1.7.2 Ubuntu 20.04

wpd commented 3 years ago

I was able to make it work by manually setting Doxygen_runner: Configuration_file_override to ${workspaceFolder}/Doxyfile.

betwo commented 3 years ago

Hi @wpd,

thank you for the feedback.

Does using configuration_file_override work for you? If this is not set, the Doxyfile is always searched relative to the currently opened file. This is to support having multiple package in the same workspace.

You could also try to make the extension recognize your individual packages using doxygen_runnercrawler_package_root_marker_files.

wpd commented 3 years ago

Hi @betwo , Yes, using configuration_file_override works for me. But generating the doxygen files without setting that variable failed to work for me, even when the currently opened file was in the same directory as my Doxyfile. The error message I received was:

Cannot find Doxyfile for /home/wpd/src/ble2ros

But I had a Doxyfile in /home/wpd/src/ble2ros:

$ ls -l /home/wpd/src/ble2ros/Doxyfile
-rw-rw-r-- 1 wpd wpd 112571 Jun 21 17:28 /home/wpd/src/ble2ros/Doxyfile

Fortunately, I now have a workaround, but I remain confused as to why I had to set configuration_file_override to make this work.