If they had begun their first try by setting the SHORT_NAMES option to YES, they would have now to set it to NO for getting the same result. They are happy.īut what they don't know is that if the SHORT_NAMES trick works, it is not because this option was the reason of the bug, but rather that it completely changes almost all the names inside the folder, so the previous generation is not seen: a completely new set of files is generated (actually leaving the previous files orphan in the folder, which could be seen as another bug as they uselessly take space but this is another problem). (7) They search on Internet the reason of this error and they find that many people have fixed it by setting the SHORT_NAMES option to YES. The reason is that the previous generation left a corrupted documentation in the folder, but they don't know it. (6) Things seem to work a little better, but now they have plenty of these "Error opening map file *.map for inclusion in the docs!". (5) After having fixed the graphViz installation problem, they run Doxygen again on the same project. Of course it wasn't, it is not included with Doxyfile! But they didn't read that yet so they return to the manual and they see that they now need to download and install graphViz (alternatively, maybe they have installed it, but not correctly). (4) They get a lot of errors because graphViz was not installed. (3) At a given time, they try to enable the "dot" (graphViz) for generating the project. (2) They try to use it for documenting some of their own projects. So probably many users proceed on the following way when using "Doxygen" for the first time : And the main reason for having "map" files missing is trying to generate graphics without having "graphViz" installed. Especially if "map" files were missing because there was an error in the previous generation. But that way, if the previous generation was faulty, several things will not get fixed. It looks like that Doxygen has an incremental feature (that is, if you generate the same documentation several times, only changed files will be reprocessed, thus improving speed). I think now that the problem is the following : Thinking a lot, I tried several things, and I ended with the following : cleaning all Doxygen generated files (in the "html" folder) in the faulty project was enough for removing the bug (that is, after doing that, the new generation ran with no error). when generating their respective Doxygen documentation, one of these projects had the bug and the second one not ! There was no apparent reason for that but. Each of them have their own configuration files, but these configuration files are absolutely identical. I have two folders which contain two side by side forks of the same project. On many places on Internet I saw users reporting having "fixed" it using the SHORT_NAMES option (try this search: ), but this didn't make sense to me.īut I finally ran in a strange situation which probably makes me finding the real reason of this problem : This is the Doxygen CMake configuration for my project: find_package(Doxygen OPTIONAL_COMPONENTS dot)ĭoxygen_add_docs(documentation README.I had this bug several times on several computers without ever understanding why. It seems that all diagrams produced by 1.8.20 result in non-working links, whereas 1.8.19 works fine. Message(STATUS "Target 'documentation' not created") Set(DOXYGEN_WARN_FORMAT "$file($line): $text")ĭoxygen_add_docs(documentation README.md targets Set(DOXYGEN_USE_MDFILE_AS_MAINPAGE README.md) Set(DOXYGEN_STRIP_FROM_INC_PATH targets/library/include) If you encounter a crash and can build doxygen from sources yourself with debug info ( -DCMAKE_BUILD_TYPE=Debug), a stack trace can be very helpful (especially if it is not possible to capture the problem in a small example that can be shared).Īdd any other context about the problem here.įind_package(Doxygen OPTIONAL_COMPONENTS dot) Try to avoid linking to external sources, since they might disappear in the future. After you verified the example demonstrates the problem, put it in a zip (or tarball) and attach it to the bug report. Such an example typically exist of some source code (can be dummy code) and a doxygen configuration file used (you can strip it using doxygen -s -u). If useful, add screenshots to help explain your problem.Īttach a self contained example that allows us to reproduce the problem. The referenced Doc should open when clicking a graph element. The Doxygen documentation is not navigating to linked pages from module graph, function graph when using png dot file format.
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |