Adding UML sequence diagrams and embedded images into the generated HTML #94
Conversation
- Bumped version to: 1.2.1
- Added support for more than one UML or image per comment block - Added "uml.lua" for testing UML and embedded images
… UML and image filenames.
…age. This can be useful to keep the documentation in the code less redundant if you want to show the UML syntax in the final documentation (HTML).
…al syntax near the image. - Improved the markdown formatting in the documentation for the forked features.
Conflicts: docs/doc.md ldoc.lua ldoc/builtin/global.lua ldoc/doc.lua ldoc/html.lua ldoc/html/ldoc_ltp.lua ldoc/markup.lua ldoc/parse.lua ldoc/tools.lua readme.md tests/styles/four.lua tests/styles/three.lua tests/styles/two.lua
Conflicts: ldoc/html/ldoc_ltp.lua
|
Nice features love to have this feature in JSdoc also |
|
This is interesting and potentially very useful, but it's going to need some cleanup before I can really consider it for merging. First we need to make sure it's completely optional and doesn't add dependencies. Second there seem to be some unrelated changes mixed in here in a few spots and perhaps some related but unnecessary bits too. Third, this needs rebasing. I know its been a long time. Is this still relevant to you? Are you interested in working on it? Or is anybody else out there using this? It would be nice to have some real world use-cases to look at while testing it. |
|
I'm afraid I have not touched this project is a very long time--nor Lua for that matter. This PlantUML feature was very useful to add readable text sequence diagrams to functions within my Lua code. When LDoc generated the documentation they were expanded into very nice PNG diagrams. I used my fork extensively in my previous work related projects. I think this would be a great feature to add to LDoc but I'm afraid I have been away from Lua too long and really don't have a use. It is a shame it has been so long. For an example of a sequence diagrams in the Lua comments have a look at: https://github.com/tysenmoore-xse/LDoc/blob/master/tests/uml.lua. This is the test file I used at the time. For some PlantUML sequence diagram examples you can go here: https://plantuml.com/sequence-diagram |
I've added the ability to embed PlantUML sequence diagram syntax in the source code comments and these will be converted to images and embedded into the generated documentation.
I've also made it possible to embed images or add links to images to your documents.
Closes #24