Closed havardAasen closed 8 months ago
Very nice! Many thanks!
The comment changes look good to me. I do not know Doxygen enough to know if there are risks involved in changing its setup like this. Perhaps the change should be split in two, one modifying the code comments, and another changing the doxygen setup?
I split up the PR, this PR only handles the Doxygen setup. The updated comments is located in #2827.
If someone used Doxygen to generate any documentation this change could surely affects it output, though seeing how old the config file was and the syntax of most of the source comments, I doubt anyone has used it for years.
Nothing internal in the LinuxCNC project uses it.
For the Doxygen configs, not that much deviates from the default.
dot
which generates diagrams, diagrams is changed from png to svg. This is mostly done to keep the size small and to increase the quality of the image. If dot
isn't found it doesn't create the diagrams.
Update code comments so they can be read by Doxygen and IDEs.Rename and update the old Doxygen config file.
For now I don't think we should do anything with Doxygen, but it has several possibilities that can be looked into
man3
files and have them generated instead.