Specador Documentation Generator - How to Generate Documentation Using the DVT Eclipse IDE

Overview

Specador generates structured, easily searchable and navigable HTML documentation from source code and comments.

You can generate HTML documentation either in batch mode or, as presented in this video, from within the DVT Eclipse IDE.

Explore the design and verification tools: https://www.dvteclipse.com
Or request a license: https://www.dvteclipse.com/request-license

Details

Introduction

Specador automatically generates accurate HTML documentation from source code comments. The documentation is structured so you can easily locate, inspect, and navigate entities like classes, modules, structs, and so on.

Generating Documentation Using the DVT Eclipse IDE

You can generate HTML documentation either in batch mode or from the DVT Eclipse IDE.

Steps to Generate Documentation

  1. In the DVT Eclipse IDE, click the Generate HTML Documentation button from the toolbar and rebuild when prompted.
  2. On the first page, set the title and specify the location for the exported documentation. Here you can also customize the navigation menu and the content of the index page.
  3. In the API Selection page, you may choose what to exclude from the generated documentation, for example, the UVM package and the assertions.
  4. In the Filtering page, you can specify a list of types or paths that will be excluded from the documentation.
  5. Next, you can specify styling-related preferences, like comment formatting style.
  6. You have the option to link the generated documentation to an existing folder, which contains pre-generated HTML documentation for commonly used IPs, like UVM. Thus, you don't have to generate the documentation of these IPs for each project which references them.

When done, DVT automatically opens the generated documentation in its internal browser. You can share the exported folder and open it in any browser, as it is not location- or tool-dependent.