search

JakubAndrysek / MkDoxy

📖 Automatically generates API documentation for your project based on Doxygen comments and code snippets in your markdown files.
https://mkdoxy.kubaandrysek.cz/
MIT License
60 stars 16 forks source link

Support for diagrams and dot files #83

Closed moschmdt closed 6 months ago

moschmdt commented 6 months ago

Thank you for the plugin - I really like it!

Is it currently supported to generate dot files or diagrams?

I tried it with the following config:

Project:
  src-dirs: src/
  full-doc: True
  doxy-cfg:
      FILE_PATTERNS: "*.cpp *.hpp"
      RECURSIVE: True
      HAVE_DOT: True
      DOT_IMAGE_FORMAT: svg
      INTERACTIVE_SVG: True
      CLASS_GRAPH: True
      INCLUDE_GRAPH: True

Unfortunately, this did not work so far.

JakubAndrysek commented 6 months ago

Look at the discussion: https://github.com/JakubAndrysek/MkDoxy/discussions/43

moschmdt commented 6 months ago

Looking forward to the new feature. Thank you!

JakubAndrysek commented 6 months ago

I have tried to implement showing diagrams, but it needs more time to finish the task. The branch is under development: https://github.com/JakubAndrysek/MkDoxy/tree/diagrams-support

JakubAndrysek commented 6 months ago

If you want to help with the development, I would be grateful.