GNOME Bugzilla – Bug 795962
Issue with /includedoc and plantuml content file
Last modified: 2018-07-30 10:05:39 UTC
Created attachment 371830 [details] Files to reproduce Trying to use the /includedoc command to include an external file with Plantuml content. The feature works well with the attached test.puml but if I tried with another file (attached MQTT_Updater_FSM.puml), the built generates a wrong output (see attached error picture.jpg). The PlantUml code is correct : if I copy-paste the content of the MQTT_Updater_FSM.puml directly in the comment, the diagram is correctly generated
Can you please attach a, small, self contained example (all source+config files in a tar or zip) that allows us to reproduce the problem? From the picture it looks like there is a problem the way plantuml steers the call to dot or it cannot fid the dot executable at the indicated path.
Created attachment 372523 [details] Sample to gen docs showing the PlantUML path bug I have just encountered this problem with 1.8.14, at least it seems to be the same problem, in that the PLANTUML_INCLUDE_PATH is ignored. Attached is a sample demonstrating the problem, and a workaround. The first time this is run, the error which appears is: Running PlantUML on generated file /Users/andydent/dev/touchgramdesign/doxygeneratedTG4IM/html/inline_umlgraph_1.pu Preprocessor Error: Cannot include /Users/andydent/dev/touchgramdesign/doxygeneratedTG4IM/html/handDrawnStyle.iuml Error line 2 in file: /Users/andydent/dev/touchgramdesign/doxygeneratedTG4IM/html/inline_umlgraph_1.pu Some diagram description contains errors error: Problems running PlantUML. Verify that the command 'java -jar "/Library/Java/Extensions/plantuml.jar" -h' works from the command line. Exit code: 1 Note that the PlantUML preprocessor is attempting to include a file from the DESTINATION directory. This is ignoring the configuration setting PLANTUML_INCLUDE_PATH = ./iumltToCopy The workaround in the attached archive is to use HTML_EXTRA_FILES to specify the include file. That requires running Doxygen more than once, each time the style file is modified, as the copy phase is after DOT generation.
zip file contains only 2 plantumpl files and an image. Can you please attach a, small, self contained example (all source+config files in a tar or zip) that allows us to reproduce the problem?
I just downloaded my sample "SampleDoxygenPlantUML Generation - Touchgram for iMessage Design.zip" to check. It contains an entire directory: Touchgram for iMessage Design: doc: mainpage.md scenarios.md iumlToCopy: handDrawnStyle.iuml README.md TG4iMsg DesignDoc.doxy I then opened TG4iMsg DesignDoc.doxy and ran Doxygen - it demonstrates the problem.
(In reply to albert from comment #3) > zip file contains only 2 plantumpl files and an image. I think you downloaded the FIRST attachment, from Christophe Seyler, not the attachment on my comment attachment 372523 [details].
Thanks indeed, I mixed the 2 zip files. Sorry for the confusion.
@Andy: Why do you use: PLANTUML_INCLUDE_PATH = ./iumltToCopy and a directory called: iumlToCopy
@Christophe SEYLER any possibility of the, small, self contained example (all source+config files in a tar or zip) that allows us to reproduce the problem?
@albert >Why do you use: >PLANTUML_INCLUDE_PATH = ./iumltToCopy Ahh, that was left in from when I was trying to use the include path. I used a separate directory for the "include" files to keep them distinct.
@Andy, I can imagine the separate directories. But with the correct directory name I think there is no problem.
SORRY This IS embarrassing. Literally, I had to get new reading glasses, and I didn't notice the typo in the include path. Thanks @albert, it works! (I was busy testing it at the same time as you just now)
A typo's can always happen and they are the hardest to find as the brain filters them out (took me a while as well before I saw it).
As discussed in https://github.com/doxygen/doxygen/pull/734 , Doxygen has moved its issue tracking to https://github.com/doxygen/doxygen/issues All Doxygen tickets in GNOME Bugzilla have been migrated to Github. You can subscribe and participate in the new ticket in Github. You can find the corresponding Github ticket by searching for its Bugzilla ID (number) in Github. Hence I am closing this GNOME Bugzilla ticket. Please use the corresponding ticket in Github instead. Thanks a lot!