Doxygen generated documentation Posted

[Sean@IDV]

Hey OVMers,

I've posted some doxygen generated documentation of the OVM library on my site. I think you'll find it useful.

http://www.intelligentdv.com/blog/11...oxygen-posted/

Check out the inheritance diagram for ovm_object! Impressive - if not a little overwhelming...

If you're not familiar with doxygen then you should *really* check this out. The search comes in handy.

-Sean

PS - those of you who read multiple verif forums will notice that this is cross posted... sorry 'bout that. I'm proud of my doxygen filter...

[rsim]

thanks

[akhailtash]

That's great. I was wondering if you be releasing your filter?

-- Amal

[Sean@IDV]

Hi Amal,

I am planning on releasing the filter under GPL depending on demand. If I see at least a handful of requests on the blog then I'll open the subversion repository that I have it (along with some other doxygen runtime scripts) stored in. (So far no comments ).

At this point the hard part is updating the download page and writing the blog post that explains how to use it (and how to fix it...).

So - since this isn't my 'day job,' look for an update next weekend.


-Sean

[akhailtash]

Thanks Sean,

It's great work. I wish there were open source documentation tools for pure Verilog and VHDL too.

I have not used doxygen much to know how easy/difficult it is to add other languages.

-- Amal

[larrylikesyou]

Thanks, great work. I'm interested in the filter as wel. For the moment we're using NaturalDocs, but the support we added is limited.

[jgg]

Yeah, those are really nice, I hope you are willing to work to get that support added into doxygen. I've heard there is vhdl and verilog support already and having this would be fantastic.

Especially if the documentation in the OVM manual was moved into doxgyen comment markup..

[kevinhy]

This looks great. I would be very grateful if you made your filter available, doxygen is a fantastic tool.

Kev

[Sean@IDV]

Hi Kev,

The filter has been available for a while now... sorry that I didn't announce that here.

All of the scripts along with examples are found on this blog post:
Doxygen Filter for System Verilog


-Sean

[kevinhy]

thank you kindly...that's made my day.
Kev