pseudomuto / protoc-gen-doc

Documentation generator plugin for Google Protocol Buffers
MIT License
2.62k stars 462 forks source link

For markdown, <a name="top"/> is incorrect syntax. anchors should not be self-closing #368

Closed frolickingferret445 closed 6 years ago

frolickingferret445 commented 6 years ago

Whenever generating a markdown file with protoc-gen-doc, there are anchors/links added to sections so that they can be referred back to. For example, the top of a file will contain :

<a name="top"/>

Then, later in the document, there are links back to where the first link was placed:

<a href="#top">Top</a>

This is pretty straightforward, but the syntax<a name="top"/> and similar links like<a name="etc"/> are incorrect. anchor tags should not be self-closing. <a name="etc"><a/> should be used instead, right?

I have tested this with the latest version of protoc-gen-doc and I am still seeing the issue.