Skip to main content
Avgerinos
Associate III
June 9, 2021
Question

Doxygen with STM32CubeIDE

  • June 9, 2021
  • 2 replies
  • 4426 views

Hello

I tried to use doxygen to a project folder from STM32CudeIDE but it does not generate the documentation. I also looked on how to use doxygen on eclipse but still no results.

Is there a way to use doxygen or any other tool for generating documentation on a project from STM32CubeIDE?

This topic has been closed for replies.

2 replies

Pavel A.
Super User
June 9, 2021

CubeIDE is Eclipse, whatever solution works for other Eclipses will work for CubeIDE.

TwelveSquared
Associate III
June 9, 2021

You can run doxygen from the command line.

You must have a proper doxygen configuration file. You can generate the default one with 'doxygen -g' at the command line, then edit the resulting file.

In the configuration file, you have to tell it how/where to find the sources that it is supposed to document.

If you are missing the configuration file or doxygen cannot find the sources, it won't work.