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

Documenter HTML labels #7

Open
smgl9 opened this issue Mar 24, 2021 · 1 comment
Open

Documenter HTML labels #7

smgl9 opened this issue Mar 24, 2021 · 1 comment
Assignees

Comments

@smgl9
Copy link
Contributor

smgl9 commented Mar 24, 2021

TerosTechnology/vscode-terosHDL#46

@GlenNicholls
Copy link

@smgl9 @qarlosalberto Below is my test code for the documenter for HTML linking:

--! i_strobe: comment <a name="id1">name/nothing</a>
--! o_pulse: should display this not name <a name="id2">name/nothing</a>
entity PulseGen is
    generic (
        NumRegs : natural := 0
    );
    port (
        --! clock
        clk   : in std_logic;
        reset : in std_logic; --! reset

        i_strobe  : in  std_logic; --! [name](#id1)
        o_strobe  : out std_logic;
        --! [name](#id2)
        o_pulse   : out std_logic;
        o_rising  : out std_logic;
        o_falling : out std_logic
    );
end entity PulseGen;

This displays the following:
image

I believe that comment should be the description for i_strobe in Table 1.2 and should display this not name for o_pulse. As I mentioned in TerosTechnology/vscode-terosHDL#46, it would be nice to describe the port list above the entity to make large port maps readable in the code when descriptions are somewhat complicated.

@smgl9 smgl9 self-assigned this Jun 30, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants