introduction to plantuml - wilkening-online · • plantuml script placed within doxygen comments...
TRANSCRIPT
![Page 1: Introduction to PlantUML - Wilkening-Online · • PlantUML script placed within Doxygen comments in source code • Doxygen executes PlantUML and places images in generated doc •](https://reader030.vdocuments.us/reader030/viewer/2022040118/5e1efda566cf496d44699036/html5/thumbnails/1.jpg)
© 2016 Georg Hellack
PlantUML
Scripting UML Diagrams
![Page 2: Introduction to PlantUML - Wilkening-Online · • PlantUML script placed within Doxygen comments in source code • Doxygen executes PlantUML and places images in generated doc •](https://reader030.vdocuments.us/reader030/viewer/2022040118/5e1efda566cf496d44699036/html5/thumbnails/2.jpg)
© 2016 Georg Hellack
UML Sequence Diagram...
![Page 3: Introduction to PlantUML - Wilkening-Online · • PlantUML script placed within Doxygen comments in source code • Doxygen executes PlantUML and places images in generated doc •](https://reader030.vdocuments.us/reader030/viewer/2022040118/5e1efda566cf496d44699036/html5/thumbnails/3.jpg)
© 2016 Georg Hellack
... from a Script
![Page 4: Introduction to PlantUML - Wilkening-Online · • PlantUML script placed within Doxygen comments in source code • Doxygen executes PlantUML and places images in generated doc •](https://reader030.vdocuments.us/reader030/viewer/2022040118/5e1efda566cf496d44699036/html5/thumbnails/4.jpg)
© 2016 Georg Hellack
Supported Diagram Types
Structural Diagrams Behavioural Diagrams
• Component • Use Case
• Class • Sequence
• Deployment • Activity
• Object • State
![Page 5: Introduction to PlantUML - Wilkening-Online · • PlantUML script placed within Doxygen comments in source code • Doxygen executes PlantUML and places images in generated doc •](https://reader030.vdocuments.us/reader030/viewer/2022040118/5e1efda566cf496d44699036/html5/thumbnails/5.jpg)
© 2016 Georg Hellack
Use Case Diagram
![Page 6: Introduction to PlantUML - Wilkening-Online · • PlantUML script placed within Doxygen comments in source code • Doxygen executes PlantUML and places images in generated doc •](https://reader030.vdocuments.us/reader030/viewer/2022040118/5e1efda566cf496d44699036/html5/thumbnails/6.jpg)
© 2016 Georg Hellack
Class Diagram
![Page 7: Introduction to PlantUML - Wilkening-Online · • PlantUML script placed within Doxygen comments in source code • Doxygen executes PlantUML and places images in generated doc •](https://reader030.vdocuments.us/reader030/viewer/2022040118/5e1efda566cf496d44699036/html5/thumbnails/7.jpg)
© 2016 Georg Hellack
Activity Diagram
![Page 8: Introduction to PlantUML - Wilkening-Online · • PlantUML script placed within Doxygen comments in source code • Doxygen executes PlantUML and places images in generated doc •](https://reader030.vdocuments.us/reader030/viewer/2022040118/5e1efda566cf496d44699036/html5/thumbnails/8.jpg)
© 2016 Georg Hellack
State Diagram
![Page 9: Introduction to PlantUML - Wilkening-Online · • PlantUML script placed within Doxygen comments in source code • Doxygen executes PlantUML and places images in generated doc •](https://reader030.vdocuments.us/reader030/viewer/2022040118/5e1efda566cf496d44699036/html5/thumbnails/9.jpg)
© 2016 Georg Hellack
Applications using PlantUML
Consult http://plantuml.com/running.html for updated
list and links to the different tools.
![Page 10: Introduction to PlantUML - Wilkening-Online · • PlantUML script placed within Doxygen comments in source code • Doxygen executes PlantUML and places images in generated doc •](https://reader030.vdocuments.us/reader030/viewer/2022040118/5e1efda566cf496d44699036/html5/thumbnails/10.jpg)
© 2016 Georg Hellack
Architecture
Online Editors
(e.g. PlantText)
Doc Generators
(e.g. Doxygen)
Word Template
(e.g. Doxygen)
plantuml.jar
Graphviz
dot.exe
![Page 11: Introduction to PlantUML - Wilkening-Online · • PlantUML script placed within Doxygen comments in source code • Doxygen executes PlantUML and places images in generated doc •](https://reader030.vdocuments.us/reader030/viewer/2022040118/5e1efda566cf496d44699036/html5/thumbnails/11.jpg)
© 2016 Georg Hellack
Online Editor
![Page 12: Introduction to PlantUML - Wilkening-Online · • PlantUML script placed within Doxygen comments in source code • Doxygen executes PlantUML and places images in generated doc •](https://reader030.vdocuments.us/reader030/viewer/2022040118/5e1efda566cf496d44699036/html5/thumbnails/12.jpg)
© 2016 Georg Hellack
Doxygen
• PlantUML script placed within Doxygen comments in source code
• Doxygen executes PlantUML and places images in generated doc
• ! It is no longer necessary to parse the PlantUML code separately
and add references to images in Doxygen comments !
• path to plantuml.jar must be specified in Doxygen configuration
![Page 13: Introduction to PlantUML - Wilkening-Online · • PlantUML script placed within Doxygen comments in source code • Doxygen executes PlantUML and places images in generated doc •](https://reader030.vdocuments.us/reader030/viewer/2022040118/5e1efda566cf496d44699036/html5/thumbnails/13.jpg)
© 2016 Georg Hellack
Doxygen
![Page 14: Introduction to PlantUML - Wilkening-Online · • PlantUML script placed within Doxygen comments in source code • Doxygen executes PlantUML and places images in generated doc •](https://reader030.vdocuments.us/reader030/viewer/2022040118/5e1efda566cf496d44699036/html5/thumbnails/14.jpg)
© 2016 Georg Hellack
Word Macros
• Download Word template ‚PlantUML_Template_v30.dotm‘
• ! current template not suitable for 64bit version of Word !
• Copy *.dotm file to %appdata%\Microsoft\Word\STARTUP
• Note: run 'echo %appdata%‘ to check value of ‘appdata’
• restart Word -> menu item ‘PlantUML’ should appear
![Page 15: Introduction to PlantUML - Wilkening-Online · • PlantUML script placed within Doxygen comments in source code • Doxygen executes PlantUML and places images in generated doc •](https://reader030.vdocuments.us/reader030/viewer/2022040118/5e1efda566cf496d44699036/html5/thumbnails/15.jpg)
© 2016 Georg Hellack
Word Macros
• PlantUML script within Word document; can be hidden for final doc
![Page 16: Introduction to PlantUML - Wilkening-Online · • PlantUML script placed within Doxygen comments in source code • Doxygen executes PlantUML and places images in generated doc •](https://reader030.vdocuments.us/reader030/viewer/2022040118/5e1efda566cf496d44699036/html5/thumbnails/16.jpg)
© 2016 Georg Hellack
Resources and Links
• PlantUML: http://plantuml.com/
• Word Template:
https://sourceforge.net/projects/plantuml/files/PlantUML_Template_v30.dotm/download
• Graphviz (for dot.exe): http://www.graphviz.org/
• Doxygen: www.doxygen.org/
• Website for editing and testing scripts: http://www.planttext.com
![Page 17: Introduction to PlantUML - Wilkening-Online · • PlantUML script placed within Doxygen comments in source code • Doxygen executes PlantUML and places images in generated doc •](https://reader030.vdocuments.us/reader030/viewer/2022040118/5e1efda566cf496d44699036/html5/thumbnails/17.jpg)
© 2016 Georg Hellack
The End