Hi,
I have a question regarding Auto-generate doc script, UVM to HTML:
We're in a process of defining UVM coding guidelines in our group.
We would like to guide engineers to write code and comments in a way that a script can run to auto-generate HTML doc from comments (to document classes, functions, variables, macros, etc).
We've noticed that UVM class reference doc was auto-generated from comments in UVM library files.
does this script (that generate HTML) is part of UVM library ?
can we run it on our own code to generate HTML ? if yes, then how ?
Is it releated to $UVM_HOME/docs/html/javascript/ (main.js, searchdata.js) ?
What are the coding guidelines to support this script ?
it seems the script search for comments in such format:
// CLASS: uvm_sequencer #(REQ,RSP)
// Variable: seq_item_export
// Function: new
// Function: stop_sequences
// Title: Report Macros
// MACRO: `uvm_info