Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Auto documentation bugs/wrong documentation for VHDL #704

Open
ArnePret opened this issue Nov 14, 2024 · 0 comments
Open

Auto documentation bugs/wrong documentation for VHDL #704

ArnePret opened this issue Nov 14, 2024 · 0 comments
Labels
bug Something isn't working

Comments

@ArnePret
Copy link

ArnePret commented Nov 14, 2024

Official Documentation:
https://terostechnology.github.io/terosHDLdoc/docs/guides/documenter/vhdl_elements
https://terostechnology.github.io/terosHDLdoc/docs/guides/documenter/virtual_bus

To Reproduce
The virtualbus feature is only partially working in VHDL. The @keepports is added to the comment, instead of keeping the ports.
--! @virtualbus ControlInterface @keepports
i_sl_Control1 : in std_logic;
i_sl_Control2 : in std_logic;
--! @EnD

image
image

According to the documentation on terostechnology.github.io Instances should be supported for VHDL Auto Documentation, but they don't appear in the generated output.

Please complete the following information:

  • OS: Windows 11
  • VSCode version version: 1.95.2
  • TerosHDL version: 6.0.14
@ArnePret ArnePret added the bug Something isn't working label Nov 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

1 participant