After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 795962 - Issue with /includedoc and plantuml content file
Issue with /includedoc and plantuml content file
Status: RESOLVED OBSOLETE
Product: doxygen
Classification: Other
Component: build
1.8.14
Other Windows
: Normal normal
: ---
Assigned To: Dimitri van Heesch
Dimitri van Heesch
[moved_to_github]
Depends on:
Blocks:
 
 
Reported: 2018-05-09 06:47 UTC by Christophe SEYLER
Modified: 2018-07-30 10:05 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
Files to reproduce (8.03 KB, application/zip)
2018-05-09 06:47 UTC, Christophe SEYLER
Details
Sample to gen docs showing the PlantUML path bug (35.41 KB, application/x-compressed-tar)
2018-06-03 05:59 UTC, Andy Dent
Details

Description Christophe SEYLER 2018-05-09 06:47:14 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
Comment 1 albert 2018-05-09 08:11:16 UTC
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.
Comment 2 Andy Dent 2018-06-03 05:59:46 UTC
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.
Comment 3 albert 2018-06-12 07:35:24 UTC
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?
Comment 4 Andy Dent 2018-06-12 07:42:44 UTC
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.
Comment 5 Andy Dent 2018-06-12 07:45:46 UTC
(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].
Comment 6 albert 2018-06-12 07:48:38 UTC
Thanks indeed, I mixed the 2 zip files. Sorry for the confusion.
Comment 7 albert 2018-06-12 11:58:47 UTC
@Andy:

Why do you use:
PLANTUML_INCLUDE_PATH  = ./iumltToCopy

and a directory called:
iumlToCopy
Comment 8 albert 2018-06-12 12:03:50 UTC
@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?
Comment 9 Andy Dent 2018-06-12 13:25:58 UTC
@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.
Comment 10 albert 2018-06-12 13:40:59 UTC
@Andy, I can imagine the separate directories. But with the correct directory name I think there is no problem.
Comment 11 Andy Dent 2018-06-12 13:42:30 UTC
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)
Comment 12 albert 2018-06-12 13:45:12 UTC
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).
Comment 13 André Klapper 2018-07-30 10:05:39 UTC
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!