You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The hdlConvertor rules for parsing of the comments are following.
All comments directly before current object are interpreted as a doc of an object
The comments after an object on the same line as the start of the object are appended to a doc of the object.
Each comment is added to a doc of any object once at most.
The doc which does not satisfy any previous condition is omitted from the doc. This involves comments inside of an expressions and other object which can have newline in body.
(Note that it is not possible to infer what object the comment belongs in general, because the comment is not something which is tied to some language object like docstring in python. The hdlConvertor tries the best effort. )
There are objects which can store a comment. The doc string is stored in doc property of the parsed object. Classes of doc capable objects do inherit from
The current problem is that there is not a complete test of all possible VHDL object and for some objects the doc is not parsed or converted back to VHDL.
In order to solve this we need an example VHDL code which will demonstrate a comments which should be converted to a doc for every existing object.
The hdlConvertor rules for parsing of the comments are following.
(Note that it is not possible to infer what object the comment belongs in general, because the comment is not something which is tied to some language object like docstring in python. The hdlConvertor tries the best effort. )
There are objects which can store a comment. The doc string is stored in doc property of the parsed object. Classes of doc capable objects do inherit from
Nearly all objects are doc capable excluding expressions, operators and other descriptors which are part of some larger code construct.
@andrasm62
The text was updated successfully, but these errors were encountered: