Specador Documentation Generator
Specadorは、Verilog、SystemVerilog、VHDL、e言語で書かれたソースコードを使用するハードウェア設計および検証エンジニアのために正確なドキュメントを自動生成するツールです。
Specadorを使用すると、設計および検証エンジニアは、適切で整理されたドキュメントを簡単に作成し、管理することができます。HTMLまたはPDFを生成し、バッチモード（コマンドライン）で動作し、専用の言語パーサーを使用します。
このドキュメンテーション・ジェネレータは、コードをコンパイルし、プロジェクトの構造を理解するため、ユーザは、追加コンテキストを提供するコメントが存在しない場合でも、設計または検証環境のドキュメンテーションに利用することができます。そのため、例えばクロスリンクされたクラス継承ツリー、デザイン階層、ダイアグラムなどを作成することができます。
ドキュメントは常にソースコードと同期しているため、ダイアグラムの管理や、ポートや関数の引数リストを現在のバージョンに合わせて更新するといった、綿密で問題が発生しやすい作業を省くことができます。
IPプロバイダや社内でIPベースの設計を行っている人々にとって、IPのパッケージ化に特に役立ちます。
SpecadorはMarkdownとreStructuredTextの構文を認識し、HTMLやPDF出力の可読性を高めるために、ドキュメントのコメントを自由にフォーマットすることができます。
特長
- ドキュメントは、関係性と構造的な情報の両方を含む、言語固有の概念で構成されています。たとえば、パッケージ、クラス、エンティティ、モジュール、構造体などの専用カテゴリがあり、クラスの継承、デザイン階層、エンティティ・アーキテクチャを簡単に調べることができるため言語の認識を高めるのに役立ちます
- クロスリンクされたドキュメント。ユーザは、関数のドキュメントからその引数の1つに、またはモジュール定義からそのサブモジュールの1つに簡単にジャンプすることができます。
- ブロック図や回路図、継承図やコラボレーションUMLクラス図などの図を自動的に生成できます。ダイアグラムはハイパーリンクでリンクされており、ユーザはダイアグラム内のクラスをクリックすると、そのクラスがドキュメント化されている章にジャンプしたり、概略図内のサブモジュールをクリックすると、サブモジュールの章にジャンプしたりすることができます。
- パッケージングされたデータ型またはUVMレジスタ・コンフィグレーション・メソッドを解析してビットフィールド・ダイアグラムを生成します。
- 波形ダイアグラム 一般的なオープンソースのWaveDromフォーマットを使用して指定された波形を作成します。
- ドキュメント・ジェネレーターは、ディレクティブをコメントで受け取り、それを外部のスクリプト/ツールに与えて処理し、生成されたダイアグラムをドキュメントに含めることができます。
- ドキュメントには、例えば、カバレッジやチェックに焦点を当てた情報を集約したセクションが含まれるためレビューに役立ち。
- ユーザは生成されたドキュメントを簡単に検索できます。
- SpecadorはMarkdownおよびreStructuredText構文を認識するため、ユーザは太字、斜体、リストなどの属性を使用してHTMLおよびPDFベースの美しいドキュメントを生成できます。
- ユーザは、作成するドキュメントをコントロールすることができます。パッケージ全体やプライベートAPIを除外したり、内部APIを公開したくない場合に、どのAPIサブセットをドキュメント化するかを選択したりできます。
- 埋め込みドキュメントやリンク・ドキュメントの追加。外部ドキュメントの埋め込み、目次へのメニューの追加、MS WordやPDFドキュメントへのリンクの追加、スクリーンショットの追加、他のドキュメント・フレームワークとの統合が簡単にできます。
- Specadorは、他のIPやプロジェクトの事前生成されたドキュメントへのクロスリンクを自動的に作成します。
メリット
・限られたソースコードのコメントからでも、整理された効果的なドキュメントを生成
・既存の開発フローに簡単に統合できるため、設計グループや検証グループによるドキュメント作成プロセスを自動化
・生成されたドキュメントはソースコードと同期しているため、時間を節約し、メンテナンス・コストを削減
・IPパッケージングの強化
・適切なソースコードの文書化を促進
・既存のソースコードを取り込んで可読性の高いメンテナンス可能なドキュメントを生成