svstuff / systemverilog

SystemVerilog stuff and stuff.
http://svstuff.github.io/systemverilog
MIT License
11 stars 4 forks source link

check documentation tags #1

Open svstuff opened 9 years ago

svstuff commented 9 years ago

It should be pretty simple to extract documentation tags (doxygen tags, say) from comments. These can be matched against the element they belong to, e.g. emitting a warning/error if a param name is incorrect.

It should also be pretty simple to output doxygen XML or similar (or even just straight docbook XML, or asciidoc).

svstuff commented 9 years ago

Probably need to create comment tokens on a hidden channel, so that ANTLR will decorate the parsetree with the comments.