Export HTML/PDF Documentation

To generate HTML or PDF Documentation use the Specador: Generate Documentation command (requires a Specador license).

After you select the desired XML preferences file, a window will popup, allowing you to further customize your settings:

1. Common Settings Tab

  • Specify the documentation title, author and copyright notice

  • The output directory - target directory where the documentation will be placed

  • Select the output format of your documentation (HTML | PDF)

  • Option to include the API source code

../../_images/vscode_specador_webview_common_tab.png

2. Advanced Settings Tab

  • Option to create a custom Table of Contents

  • Select the comment formatter or apply comment filters

  • Names Filter - exclude types names that match these filters

  • Paths filter - exclude files from documentation

../../_images/vscode_specador_webview_advanced_tab.png

3. API Settings Tab

Check which libraries and which kind of API to include in the documentation.

../../_images/vscode_specador_webview_api_tab.png

4. Diagrams Settings Tab

Check which kind of diagrams you want to include in the documentation.

../../_images/vscode_specador_webview_diagrams_tab.png

Note

For more informations check out the Specador User Guide.