Specador Documentation Generator User Guide
Rev. 24.1.9, 26 April 2024
- Overview
- How to Run
- Compile Arguments
- Auto-config
- Emulating compiler invocations
- Compatibility Modes
- Paths
- Strings
- Comments
- Environment Variables
- Including Other Argument Files
- All Build Directives
- e Language Test Files
- e Language SPECMAN_PATH
- SystemVerilog OVM or UVM Library Compilation
- Xilinx Libraries Compilation
- Intel(Altera) Quartus Libraries Compilation
- Compile Waivers
- Customizations
- Diagrams
- > Comments Formatting
- Memory Monitor
- Application Notes
- What is New?
- Legal Notices
- Third Party Licenses
Markdown is one of the world’s most popular markup languages that can be used to add formatting elements to plaintext text documents. Markdown uses symbols like asterisks and dashes to create formatting like headings and bold text. This makes it quicker to write than complex HTML code. Markdown prioritizes readability by utilizing plain text and clear symbols to ensure the code remains easy to understand.
The table below lists the Markdown syntax that Specador recognizes. For more details see https://www.markdownguide.org/.
| Tag Name | Comment | Specador Output | Notes |
| Bold Font |
 |
 | |
| Bullet List |
 |
 | A bullet list is defined by starting each item with a hyphen (-), an asterisk (*), or a plus sign (+). |
| Code Block |
 |
 | A code block is defined by indenting the lines with four spaces or one tab. |
| Heading |
 |
 | |
| Italic Font |
 |
 | |
| Link |
 |
 | |
| Ordered List |
 |
 | An ordered list is defined by starting each item with a number followed by a period. The order of the numbers does not matter. |
| Quotes |
 |
 | |
| Strikethrough |
 |
 | |
| Table |
 |
 |