25.2 Comments Formatting

DVT VHDL IDE User Guide

Rev. 21.1.14, 13 April 2021

Go to Product Page

Installation Checklist
- Install DVT Using a pre-packed Distribution
- Install DVT Using the Update Site
- Check the DVT License
Predefined Projects
Getting Started
- What is a Workspace
- What is a Project
- Project Natures
- Workspace and Workbench
- Refresh
- Linked Resources
- Backup and Local History
- Basic Tutorial
Build Configurations
- Non-top files
- default.build
- Auto-config
- Simulator Log-config
- Emulating compiler invocations
- Multiple .build Files
- Compatibility Modes
  - Default DVT Compatibility Mode
  - gcc Compatibility Mode
  - ius.irun Compatibility Mode
  - ius.perspec Compatibility Mode
  - questa.vcom Compatibility Mode
  - questa.vlog Compatibility Mode
  - vcs.vhdlan Compatibility Mode
  - vcs.vlogan Compatibility Mode
  - xcelium.xrun Compatibility Mode
- Paths
- Strings
- Comments
- Environment Variables
- Including Other Argument Files
- Build Persistence
- DVT Auto-Linked
- Run a Script Before Build
- 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
- Questa Libraries Compilation
- Use of External Programs
Compile Checks
- Compile Waivers
- Semantic Checks
- Naming Conventions Checking
- Non Standard Checks
Content Assist (Autocomplete)
- Content assist for CamelCase and Underscore
- Component Automatic Instantiation
- Code Templates
- Generate Case Statement Using Autocomplete
Quick Fix Proposals
- Add Case Choice
- Add Generic to Entity
- Add Port
- Add Signal to Sensitivity List
- Correct Spelling In Comments and Strings
- Create File From Build Config Editor
- Declare Enum Value
- Declare Variable
- Did You Mean
- Fully Qualify Type
- Import Type
- Replace Deprecated Package
- Remove Library Clause
- Remove Signal from Sensitivity List
- Remove Signal Never Used
- Update Entity Instance
- Waive Compilation Problems
Content Filters
- Content Filters XML syntax
- Filtering by element type
- Content Filters Examples
- Predefined Content Filters
Code Templates
- Code Templates in Autocomplete
- Global Code Templates
- Project Level Code Templates
- Code Templates View
File Templates
Project Templates
- What is a project template?
- How to generate code from a project template
  - Step 1. Specify Directories
  - Step 2. Specify Parameters
- Template Configuration
  - template-config.xml
  - template.config
- Add from Template
Code Formatting
- Capitalization
- Whitespace
- Indentation
- Vertical Alignment
- Line Wrapping
- Disable Format for Code Sections
- Format Multiple Files
- External
Component Automatic Instantiation
- Autoinstance Using Autocomplete
- Autoinstance Using Drag and Drop
Semantic Search
Show Usages, Readers or Writers
Favorite Searches
Show Instances
Quick Search in Views
- CamelCase
- Simple Regex
- Hierarchical Search
- Search for Members
- Search Port in Design Hierarchy
Trace Connections
- Trace Connections from Design Hierarchy
- Trace Connections from Editor
- Trace Connections View
- Trace Path
Breadcrumb Navigation Bar
- Design Breadcrumb
- Scope Breadcrumb
Code Factory
Refactoring
- Rename Refactoring
- Rename Port Across the Design Hierarchy
- Extract to Variable
- Add New Port to Entity
- Add New Generic to Entity
- Connect Instances Across the Design Hierarchy
Diagrams
- Design Diagrams
- Diagram Actions
- Diagram Toolbar
- WaveDrom Timing Diagrams
Low Power Format Support
- Supply Network Diagram
> Export HTML Documentation
- Export HTML Documentation Wizard
- > Comments Formatting
  - JavaDoc
    - JavaDoc Support
  - NaturalDocs
    - NaturalDocs Support
- Customizing Documentation
External Tools Integration
- Run Configurations
- Smart Log
- External Builders
Debugger Integration
- Simulation Prerequisites
- Launch a Debug Simulation
- Connect to an Existing Simulation
- Breakpoints
- Threads, Call Stack, Stepping
- Variables
- Watch Expressions
- Debug Specific Configurations
Custom Dialogs
- Quick Steps
- Customizing the Dialog Output
- SWT/XML Reference
  - Layouts
  - Widgets
- Custom Dialog Snapshots
  - Custom Dialog Snapshots File Syntax (XML)
Command Line Interface
- dvt_cli.sh
- Syntax
- Examples
- Makefile Example
- Commands
Reminders (TODO Markers)
Settings Management
- Managed Settings
- Unmanaged Settings
- User and Common Settings Location
- Use Cases
- Examples
- Deprecated Settings Management (before DVT 3.5)
Reference
- Comments Formatting
  - Javadoc
  - Natural Docs
- Common Shortcuts
- Custom Pragmas
- Editor Right Click Menu
  - Folding
  - Source
  - Code Factory
  - Show
  - References
  - Trace
  - Refactor
- Hyperlinks
  - Hyperlinks in Comments
- Icons and Decorations
- Scripts
- Syntax Coloring
- Themes
- Toolbar Actions
- Tooltips
- Views
Application Notes
- C/C++ support
- FPGA Support
  - Intel(Altera) Quartus
    - Intel(Altera) Quartus Libraries Compilation
  - Xilinx ISE/Vivado
    - Xilinx Libraries Compilation
- OSVVM Support
- UVVM Support
- Generating External Tool Scripts from the DVT Build Configuration
Tips and Tricks
Q & A
- I am new to Eclipse, where should I start from?
- Where can I find DVT Help?
- How do I see and configure the key shortcuts?
- Are there any backup files in Eclipse?
- Workspace in use, cannot launch eclipse...
- Locking is not possible in the directory...
- How to start DVT Eclipse with a different eclipse.ini
- Save could not be completed
- IBM Clearcase Plugin
- DVT is crashing with "Problematic frame ld-linux-x86-64.so.2 _dl_rtld_di_serinfo
- libxul.so undefined symbol
- How to use Working Sets for filtering Problems/Task/Search views?
- How do I Access Files Outside Project Dir - Working with Linked Resources
- Mapping Linux to Windows (/proj/ to Z:\proj\)
- Subversive vs Subclipse
- How do I associate a project with both DVT and CDT?
- Can I use vi/vim along with DVT?
- Can I perform dos2unix or unix2dos from DVT?
- How can I configure Eclipse to use a local CVS repository?
- I am using the Common Desktop Environment via Citrix and experiencing crashes. What can I do?
- How do I change the background color of the Editor?
- Some widget colors are not displayed properly. What can I do?
- How do I change the tooltip colors?
- How do I change Internet Proxy Settings?
- Eclipse does not start, there is no Workspace, metadata or log file created
- Workspace permissions
- How do I link mylyn with Bugzilla?
- How do I print source code?
- How do I disable Eclipse Software Sites?
- How do I revert to a previous version?
- What are the most common shortcuts in DVT?
- How does DVT integrate with CVS?
- How to set an environment variable within a Run Configuration?
- How to run a remote Unix command from DVT Eclipse for Windows?
- Rebuild shortcut (Ctrl + Alt + R) does not work
- I want to use an alias in a DVT Generic Run Configuration, but it's not recognized
- How to set multiple paths as sources of predefined projects ?
- Lines are suddenly changing indentation when I edit text or move the cursor through the editor.
- How to change the directory where the build log file is saved ?
- How to find the DVT logs on Linux/Unix ?
- How to create resource filters ?
- How to create custom shortcut and button for a Run Configuration?
- I know that file.foo is present in the project location, but I can't see it in the Navigator View
- How to copy the full path to the file in the current editor?
- How to adjust the console logs filters matching parameters?
- When I switch to Block (Column) Selection mode the font changes
- In Block (Column) Selection mode I see strange editng artifacts
- How to modify the font size in the code editors?
- How to automatically checkout/lock files from the revision control system ?
- How can I see if a file is read-only?
- How can I open a file in DVT from the terminal?
- How can I open a file in DVT from Questa?
- How do I change the name of the xterm opened by a DVT Generic Run Configuration?
What is New?
How to Report an Issue?
Legal Notices
Third Party Licenses

Prev Home Next Up

25.2 Comments Formatting

Table of Contents

25.2.1. JavaDoc
25.2.2. NaturalDocs

There are two formatting styles supported: JavaDoc & NaturalDocs. You can use HTML syntax in JavaDoc comments .

Prev Home Next Up