Re: VHDL Hierarchy

Richard Damon <[email protected]>
Newsgroups gmane.text.doxygen.general
Message-ID <[email protected]>
On 4/26/17 6:32 AM, Larry wrote:
>
> Hello.  I’m new to Doxygen and have spent many hours trying to find 
> this answer on my own.  I will apologize ahead of time if I should 
> have been able to find this without bothering the mailing list …
>
> Is there any way to specify the “Top-Level” entity of set of VHDL 
> code, and have Doxygen ignore any entities which it finds in the 
> doxygen search path which are **not** in the hierarchy below the 
> top-level entity?
>
> The reason I ask is because I have VHDL designs which instantiate 
> entities from a pool of VHDL utilities.  If I put the utilities 
> libraries in the Doxygen search path, the resulting Doxygen 
> documentation accurately describes the complete hierarchy, but also 
> includes a ton of confusing extraneous stuff that is not relevant to 
> the design being documented.   If I don’t include the libraries, the 
> documentation of the relevant hierarchy is not complete.
>
> If this feature is not currently supported, can anyone give me advice 
> on how one might go about adding it?  I have the all the doxygen 
> sourcecode downloaded and running in Eclipse.  I have also been able 
> to successfully rebuild the VHDL parser using javacc.  I’m having a 
> little trouble getting up to speed on all the code and determining 
> which features are supported and/or how to add features.  Or, is there 
> anyone out there willing to add features for hire? (I hope that ok to 
> ask on the mailing list.)
>
> ...
>
> Gary
>
My understanding of Doxygen is the it doesn't have any from of pruning 
the source file list to only what is "needed". That actually would be a 
somewhat tricky problem, as it would be language dependent (C++ with its 
overloads, especially operator xxx()s would require basically a FULL: 
parsing of the code).

One option would be to not include the whole library directory as an 
input, but only the specific files that you need from the library.

-- 
Richard Damon


------------------------------------------------------------------------------
Check out the vibrant tech community on one of the world's most
engaging tech sites, Slashdot.org! http://sdm.link/slashdot
lmpx.com only provides a reader for public news (NNTP) servers. It is not affiliated with the servers or forums shown here and is not responsible for the content of articles, which is written by their respective authors.