Forum Discussion

JoEl's avatar
JoEl
Icon for Occasional Contributor rankOccasional Contributor
6 years ago
Solved

How to fill Platform designer documentation

Hi all, I am looking for some source code documentation tool like doxygen for SystemVerilog with no luck, but I find that Quartus can generate nice HTML block design. How can I insert code in it ? I...
  • KennyT_altera's avatar
    KennyT_altera
    6 years ago

    Hi Josef,

    The enhancement is for our engineering. Currently, they are no parameter that you can use for hw.tcl or setting files for this generation.

    Thanks

JoEl's avatar
JoEl
Icon for Occasional Contributor rankOccasional Contributor
6 years ago

Hi Kenny,

agree with autogenerated file, but its generated from something - so input data would be those in *_hw.tcl file. So if I know right place to write it, ti propagates from _hw.tcl to html.

If I have time in evening, I'll create example in Quartus 19.1 and post it here cause it look like we are still on opposite side.

As you can see on right picture - Unit level - there is description. Just parameters but at least something. I want to add more information there, humble wish is component description in text form, true wish would be pasting images and comment also ports/interfaces

At the end connecting this HTML tree together and use hyperlinks between unit and top would be really nice!

Thanks,

Josef