So nobody has posted the OVM (Open Verification Methodology) with Doxygen – so I thought I would.Â 🙂
I’ve posted documentation for all of the released versions of the OVM library here:
And it wasn’t easy!Â Building a “simple” doxygen filter script turned into a lesson in heuristics! It started with a simple filter script that I wrote to generate documentation for some (forthcoming) tiny library components that I’m working on.Â I thought – hey, to really test my script, maybe I’ll run the OVM through it.Â A few months later (hey – I only get to hack on this in my spare time – so stuff takes time) I had a script.Â And now I’m much more comfortable with Perl. I even have some of the regular expressions memorized now.
My favorite is the inheritance diagram for ovm_object.Â It’s huge!Â Sort of beautiful.Â And the image is huge, so be patient.Â And if all of my readers download that image – well, my readership isn’t high enough to where it should matter.Â ;)Â (That said – I’m not going to link it directly from here.)
Now that I’ve got the doxygen documentation, maybe I’ll actually take the time to learn the OVM! I’d post the documentation for the library that I use, but its, um, not open source. Ahem! And my filter (currently) barfs on all of it’s freakin’ preprocessor macros.Â (Templates people!Â Templates!)
So this filter script is a work in progress (heuristic filter – not a grammar.) So if you find something is wrong with the documentation please, please file a bug:
(And if you find filing a bug too cumbersome – then at least drop a comment on this entry or send me an email.)