●Verylではドキュメンテーション・コメントからドキュメントを生成できる

▲元になるコード

/// This is a sample module.
///
/// ```wavedrom
/// {signal: [
/// {name: 'i_clk', wave: 'p......'},
/// {name: 'i_dat', wave: 'x.=x...',
 data: ['data']},
/// {name: 'o_dat', wave: 'x...=x.',
 data: ['data']},
/// ]}
/// ```
pub module Sample #(
  /// Data Width
  param WIDTH: u32 = 1,
) (
  i_clk: input  clock       , 
/// Clock
  i_dat: input  logic<WIDTH>, 
/// Input Data
  o_dat: output logic<WIDTH>, 
/// Output Data
) {}

▲生成されたドキュメント

●参考文献

Veryl

コメントを残す