How is UVM base class documented

[krb]

Hi,

Sorry for a non-technical post.

How is UVM base class documented ?

I see the comments in UVM base class have a lot in common with the UVM reference documents.

So I was wondering if doxygen or something similar was used.

We would like to use something similar.

Thanks,

krb

Edited October 27, 2011 by krb

[uwes]

hi,

uvm uses naturalDocs. apart from naturaldocs your can doxygen (http://intelligentdv.com/downloads/index.html#doxygentools) or DVT(http://www.dvteclipse.com/ which can do javadoc, naturaldocs etc)

/uwe

[krb]

Hi uwes,

Thanks for the reply.

Does naturaldocs has inbuild support for SV ? or do I need an additional filter script of some kind ?

[krb]

Hi Uwes,

After a bit of googling, I found that I need to add these lines to this file Config/Languages.txt.

Is this it or do I need any more changes to natural docs ?

Thanks,

krb.

Language: SystemVerilog

Extensions: sv svh

Line Comment: //

Block Comment: /* */

Package Separator: ::

Enum Values: Global

Class Prototype Ender: ;

Function Prototype Ender: ;

Variable Prototype Ender: ;

Method Prototype Ender: ;

Line Extender: \

[uwes]

here are the relevant files from the uvm development:

http://uvm.git.sourceforge.net/git/gitweb.cgi?p=uvm/uvm;a=tree;f=natural_docs;h=a65b4f15c43bea9c4f438b324c6d3b2eada71545;hb=refs/heads/UVM_1_1_BUGFIX

http://uvm.git.sourceforge.net/git/gitweb.cgi?p=uvm/uvm;a=tree;f=uvm_ref;h=1ffd83fcb1bf3383e47065507e880b86493c233a;hb=refs/heads/UVM_1_1_BUGFIX

/uwe

[krb]

Hi Uwe,

Thanks a lot for the links, I now understand how to make best use of Natural Docs.

And it seems pretty flexible and powerful at the same time.

A final question, is there a way to get pdf from natural docs.

I ask because, the UVM doc has a pdf that is similar to the html docs.

Or do you convert the html docs to pdf ?

Thanks again,

krb

[achariyaD]

Hi uwes,

 

Can someone please help in explaining how pdf was generated from hdml output i.e. which tools were utilized?

 

Thanks