Jump to content

How is UVM base class documented

Recommended Posts


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.



Edited by krb
Link to comment
Share on other sites

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 ?



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: \

Link to comment
Share on other sites

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,


Link to comment
Share on other sites

  • 2 years later...

Join the conversation

You can post now and register later. If you have an account, sign in now to post with your account.
Note: Your post will require moderator approval before it will be visible.

Reply to this topic...

×   Pasted as rich text.   Paste as plain text instead

  Only 75 emoji are allowed.

×   Your link has been automatically embedded.   Display as a link instead

×   Your previous content has been restored.   Clear editor

×   You cannot paste images directly. Upload or insert images from URL.

  • Create New...