HDLdoc

HDLdoc

HDLdoc is similar to javadoc where the comments before object declarations are parsed and added associated with the object for documentation purposes. Currently this form of documentation is being used for text hovers, but in the very near term this will be expanded to aid in generating design documentation.

HdlDoc Syntax

The syntax for the hdl doc is quite straightforward, and can probably best be seen by looking at the example project supplied with this software. In general the format follows these rules :

• All doc lines are prefixed with a --*
• A general description of the object is first followed by extra descriptors
• The extra descriptors all follow the format of @{name} @{value} @{description} where the value is optional in some cases
• A small subset of html is allowed inside the description blocks which include bold, italic, and color tags

Current Descriptors

Below is a list of the currently implemented descriptors. This is an initial version and descriptors will be added with time, but efforts will be made to keep the syntax backward compatible.

• @port {port_name} {port_description} is used to describe ports
• @param {param_name} {param_description} is used to describe parameters mainly used for types
• @return {return_name} {return_description} is used to describe the return value for functions
• @latch is used to describe a latched process so it is not flagged as a warning
• @deprecated {description} is used to describe an object which should no longer be used