Doxygen support

0 votes
asked Sep 3, 2014 in Bug by albert (2,940 points)
On the page: http://plantuml.sourceforge.net/doxygen.html something is mentioned about doxygen not supporting plantuml. I think this is niot correct as of version 1.8.8 of doxygen.

 

See:
- http://www.stack.nl/~dimitri/doxygen/manual/changelog.html

- https://bugzilla.gnome.org/show_bug.cgi?id=731947

1 Answer

0 votes
answered Sep 4, 2014 by rmric (2,140 points)

That's right, doxygen.html would need an update.

Altough the plantuml support in the 1.8.8 release of doxygen is great news, it suffers from the lack of some advanced features, to name a few:

  •  @pauseuml, @unpauseuml, @appenduml are missing
  • @startuml{filename, caption, size_options_etc} not taking extra arguments
  • no ability to configure:
    • path to java application launcher
    • any options before -jar (eg. include path)
    • any options after -jar, for plantuml (eg. defines, ..)
       
 
commented Sep 4, 2014 by albert (2,940 points)
edited Sep 5, 2014 by albert
The request made to doxygen was have the possibilities to use the @startuml command. I don't know what the plans are for the future.
With the risk of being seen as picky, but in the manual (version 5737) I don't see any description of the mentioned commands (see also my unanswered question at http://plantuml.sourceforge.net/qa/?qa=2376/update-of-manual).
commented Oct 29, 2014 by albert (2,940 points)
Revisiting this question as it stated: "@startuml{filename, caption, size_options_etc} not taking extra arguments"
What are the current possibilities in plantuml?
or
where is this decoded in the plantuml source code (so I can find it myself).
commented Nov 2, 2014 by albert (2,940 points)
Sorry to bother again, but I'd like to update the doxygen part with a caption and size_options. Doxygen can do this in its own @startuml command, analogous to the image command. The answer above suggests that there are besides the filename option with the plantuml @startuml command also a caption option and size_options, but I've not been able to find them. Am I correct that that @startuml only supports the filename option?
commented Nov 6, 2014 by rmric (2,140 points)
You're right, the @startuml command only supports the filename option.

Actually, the "feature" lays with the fact that "caption, size_options_etc" (or whatever remaining args) would be *ignored* by the plantuml parser, which stops at the first comma for the file name. The extra args are only useful for Doxygen as illustrated in this topic: http://plantuml.sourceforge.net/qa/?qa=1466/passing-images-caption-in-a-doxygen-alias-woes
This has to be documented.
commented Nov 6, 2014 by albert (2,940 points)
edited Jun 29, 2018 by albert
All clear. With the image command of doxygen it is possible to add caption (and for latex) size instructions. I'll see what is possible in respect to this with the @startuml command in doxygen so that the work around is not necessary any more.
...