Specador Documentation Generator User Guide
Rev. 24.1.15, 10 July 2024

5.1 Preferences File

 <?xml version="1.0" encoding="UTF-8" standalone="no"?>
 <!DOCTYPE spechtml PUBLIC "-//DVT//specador-preferences" "specador-preferences.dtd">
 <spechtml version="6">
   <!-- Location where documentation will be generated. Relative paths are solved as relative to the current directory. -->
   <location></location>

   <!-- Delete all files in the destination directory before generating documentation. -->
   <clean-location></clean-location>

   <!-- Title. -->
   <title></title>

   <!-- Set the copyright message. -->
   <copyright></copyright>

   <!-- Generated output format (html, pdf). -->
   <output-format></output-format>

   <!-- Beautify comments: start sentences with capital letter, append dot after sentences, bfm -> BFM, dut -> DUT etc. -->
   <enhance-comments></enhance-comments>

   <!-- Syntax for comments formatting: markdown, naturaldocs, javadoc or none. -->
   <doc-formatting-type></doc-formatting-type>

   <!-- API matching the below filters with not be included in the generated documentation. Default: none. You can specify a comma-separated list of name patterns. Patterns may contain: * = any string, ? = any character. -->
   <filter-string> </filter-string>

   <!-- Provide the path to a Sphinx index.rst file to customize the Table of Contents menu. -->
   <custom-toc></custom-toc>

   <!-- You can specify one or more directory paths to be included in the exported documentation. -->
   <attach-path></attach-path>

   <!-- Inline or above comments containing one of the keywords from this list (comma separated list) will not be included. Change the strategy attribute to 'line' to skip only the lines that contain one of the keywords. -->
   <filter-comments strategy="All"></filter-comments>

   <!-- Generate documentation only for files physically located under project root. Relevant for GUI mode only. -->
   <just-project-files></just-project-files>

   <!-- Generate UML inheritance diagram for each class. -->
   <export-uml-inheritance-diagram></export-uml-inheritance-diagram>

   <!-- Generate UVM Component diagrams for each test. -->
   <export-uvm-test-diagram></export-uvm-test-diagram>

   <!-- Generate design block diagram for each module, entity. -->
   <export-design-block-diagram></export-design-block-diagram>

   <!-- Generate design flow diagram for each module, entity. -->
   <export-design-flow-diagram></export-design-flow-diagram>

   <!-- Generate design schematic diagram for each module, entity. -->
   <export-design-schematic-diagram></export-design-schematic-diagram>

   <!-- Generate finite-state machine diagrams for all state variables found in the module, entity. -->
   <export-fsm-diagrams></export-fsm-diagrams>

   <!-- Generate bitfield diagram for each UVM register. -->
   <export-bitfield-diagram></export-bitfield-diagram>

   <!-- Export source code for documented elements. -->
   <export-source-code></export-source-code>

   <!-- SYSTEMVERILOG SPECIFIC -->

   <!-- Generate modules documentation. -->
   <export-vlog-modules>true</export-vlog-modules>

   <!-- Export variables declared inside modules. -->
   <export-vlog-modules-variables>false</export-vlog-modules-variables>

   <!-- Generate interfaces documentation. -->
   <export-vlog-interfaces>true</export-vlog-interfaces>

   <!-- Generate programs documentation. -->
   <export-vlog-programs>true</export-vlog-programs>

   <!-- Generate macros documentation. -->
   <export-vlog-macros>true</export-vlog-macros>

   <!-- Generate ifndef guards documentation. Default: false. -->
   <export-vlog-ifndef-guards>false</export-vlog-ifndef-guards>

   <!-- Generate control defines documentation. Default: true. -->
   <export-vlog-control-defines>true</export-vlog-control-defines>

   <!-- Generate elements in the global scope (typedefs, classes, functions, tasks etc.). -->
   <export-vlog-global-scope>true</export-vlog-global-scope>

   <!-- Generate packages documentation. -->
   <export-vlog-packages>true</export-vlog-packages>

   <!-- Generate specific package documentation. -->
   <export-vlog-package> </export-vlog-package>

   <!-- Generate assertions documentation. -->
   <export-vlog-assertions>true</export-vlog-assertions>

   <!-- Generate covergroups documentation. -->
   <export-vlog-covergroups>true</export-vlog-covergroups>

   <!-- Generate interface signals documentation. -->
   <hide-vlog-interface-signals>false</hide-vlog-interface-signals>

   <!-- Generate class inherited variables, functions and tasks documentation. -->
   <export_vlog_class_inherited_members>false</export_vlog_class_inherited_members>

   <!-- VHDL SPECIFIC -->

   <!-- Generate libraries documentation. -->
   <export-vhdl-libraries>true</export-vhdl-libraries>

   <!-- Generate specific library documentation. -->
   <export-vhdl-library> </export-vhdl-library>

   <!-- E LANGUAGE SPECIFIC -->

   <!-- Generate macro documentation. -->
   <export-e-macro>true</export-e-macro>

   <!-- Generate packages documentation. -->
   <export-e-packages>true</export-e-packages>

   <!-- Generate specific package documentation. -->
   <export-e-package> </export-e-package>

   <!-- Generate covergroups documentation. -->
   <export-e-covergroups>true</export-e-covergroups>

   <!-- Generate checks documentation. -->
   <export-e-checks>true</export-e-checks>

   <!-- Generate tests documentation. -->
   <export-e-tests>true</export-e-tests>

 </spechtml>