CODEWITHSUNDEEP
doxygenvhdlgraphviz
user2173236
user2173236

Reputation: 29

Doxygen with Graphviz to document VHDL

I don't manage to add a graphviz (@dot) to my doxygen documented VHDL files. Can somebody provide some example code?

I would like to add fsm graphical representation to my code.

thanks in advance

Upvotes: 2

Views: 2099

Answers (2)

S.Dong
S.Dong

Reputation: 11

  1. comment with --!;
  2. start with @dot and stop with @enddot

Example:

--! @dot
--! digraph finite_state_machine {
--!     rankdir=LR;
--!     size="8,5"
--!     node [shape = circle];
--!     S0 -> S1 [ label = "010" ] 
--!     S1 -> S0 [ label = "000" ]
--!     S1 -> S2 [ label = "111" ]
--!     S2 -> S0 [ label = "101" ]
--! }
--! @enddot

Upvotes: 1

user2099996
user2099996

Reputation: 134

Just write the dot-file manually:

digraph FSM {
    RESET -> IDLE
    IDLE  -> CALC [label="data_in = '1'"]
    CALC  -> DONE
    DONE  -> IDLE
}

Upvotes: 1

Related Questions