Thread: [Doxygen-develop] [PATCH] VHDL Component Instantiation Fixes
Brought to you by:
dimitri
From: Robert A. <ab...@un...> - 2012-03-17 06:39:39
Attachments:
0001-fix-VHDL.patch
|
Hi, I noticed that component instantiations were handled improperly: Doubly instantiated components were just hidden and not documented at all. This resulted in wrong documentation. The original hack (keeping a list inside the parser) might have been intended to relieve the "inheritance graphs" of some clutter, but that did not work properly either. Component Instances would also point to "dummy.html" instead of their containing architecture's page. I fixed that quick and dirty as well. Still, the whole VHDL module seems like one big hack anyway :-/ Patch is against the latest trunk. Signed-off-by: Robert Abel <ab...@un...> |
From: Robert A. <ab...@un...> - 2012-03-20 11:56:43
|
On 19.03.2012 20:27, Dimitri Van Heesch wrote: > Can you send me an example that I can use to test your patch? Yes, please find an example here <https://sites.google.com/site/rawbdagslair/DoxygenTestProject.7z?attredirects=0&d=1>. My example includes the VHDL instantiation bug/graph creation bug and the XML tag file bug I posted more recently to the list. You will have to run old-doxygen DoxyfileB old-doxygen DoxyfileA new-doxygen DoxyfileB new-doxygen DoxyfileA_Fix srcA contains all a DFF (sub_component), a senseless inverted DFF (sub_sub_component) and a top level entity. Instantiating sub_sub_component in toplevel will hide sub_component in toplevel completely depending on the order the instantiations are processed by the parser. So you will see different results on each parse when you switch the locations of dffA, dffNotA and dffB. On a side note, I just noticed that detail descriptions on instantiations don't work for some reason... srcB is only for showcasing the XML tag file bug. It creates two groups with "special characters" (though they aren's /that/ special...). When you look inside docA, you will find them to be gibberish. > I assume your maxlevel hack is used to see is a class is a direct > base class or sub class, right? Yes. It could be altered to be a boolean, either only direct "inheritance" or inheritance over all levels. That what would be needed for VHDL at least. However, I thought it might come in handy to have control over the depth of the recursion so the abort() can be avoided by other language parsers etc. Regards, Robert |
From: mkk1 <mk...@gm...> - 2012-03-24 21:24:18
|
Robert Abel wrote: > > On 19.03.2012 20:27, Dimitri Van Heesch wrote: >> Can you send me an example that I can use to test your patch? > > Yes, please find an example here > <https://sites.google.com/site/rawbdagslair/DoxygenTestProject.7z?attredirects=0&d=1>. > My example includes the VHDL instantiation bug/graph creation bug and > the XML tag file bug I posted more recently to the list. > > You will have to run > > old-doxygen DoxyfileB > old-doxygen DoxyfileA > > new-doxygen DoxyfileB > new-doxygen DoxyfileA_Fix > > srcA contains all a DFF (sub_component), a senseless inverted DFF > (sub_sub_component) and a top level entity. Instantiating > sub_sub_component in toplevel will hide sub_component in toplevel > completely depending on the order the instantiations are processed by > the parser. So you will see different results on each parse when you > switch the locations of dffA, dffNotA and dffB. > > On a side note, I just noticed that detail descriptions on > instantiations don't work for some reason... > > srcB is only for showcasing the XML tag file bug. It creates two groups > with "special characters" (though they aren's /that/ special...). When > you look inside docA, you will find them to be gibberish. > >> I assume your maxlevel hack is used to see is a class is a direct >> base class or sub class, right? > Yes. It could be altered to be a boolean, either only direct > "inheritance" or inheritance over all levels. That what would be needed > for VHDL at least. However, I thought it might come in handy to have > control over the depth of the recursion so the abort() can be avoided by > other language parsers etc. > > Regards, > > Robert > > ------------------------------------------------------------------------------ > This SF email is sponsosred by: > Try Windows Azure free for 90 days Click Here > http://p.sf.net/sfu/sfd2d-msazure > _______________________________________________ > Doxygen-develop mailing list > Dox...@li... > https://lists.sourceforge.net/lists/listinfo/doxygen-develop > > -- View this message in context: http://old.nabble.com/-PATCH--VHDL-Component-Instantiation-Fixes-tp33521670p33544693.html Sent from the Doxygen - Development mailing list archive at Nabble.com. |
From: mkk1 <mk...@gm...> - 2012-03-24 21:37:18
|
I modified doxygen and generated the html documention for your DoxygenTestProject example. see http://www.2shared.com/file/hneieq4a/DoxygenTestProject.html Can you verify the generated html documentation.If the documentation is correct, I can post you a patch. Martin -- View this message in context: http://old.nabble.com/-PATCH--VHDL-Component-Instantiation-Fixes-tp33521670p33544694.html Sent from the Doxygen - Development mailing list archive at Nabble.com. |
From: Robert A. <ab...@un...> - 2012-03-27 17:40:31
|
Hi Martin, On 24.03.2012 22:37, mkk1 wrote: > I modified doxygen and generated the html documention for your > DoxygenTestProject example. > see http://www.2shared.com/file/hneieq4a/DoxygenTestProject.html > Can you verify the generated html documentation. I'm not sure what you did, but it seems correct. However, your instances are kind of out-of-order. > If the documentation is > correct, I can post you a patch. Care to explain what you did differently than what was done in my patch? Did you keep the list and re-added instances later somewhere? Regards Robert |
From: mkk1 <mk...@gm...> - 2012-04-01 07:28:27
|
mkk1 wrote: > > I modified doxygen and generated the html documention for your > DoxygenTestProject example. > see http://www.2shared.com/file/hneieq4a/DoxygenTestProject.html > Can you verify the generated html documentation.If the documentation is > correct, I can post you a patch. > > Martin > The patch for generating this documentation. Patch is against the current trunk. I added some code from your patch. http://old.nabble.com/file/p33544964/svn_patch.patch svn_patch.patch Martin -- View this message in context: http://old.nabble.com/-PATCH--VHDL-Component-Instantiation-Fixes-tp33521670p33544964.html Sent from the Doxygen - Development mailing list archive at Nabble.com. |
From: Robert A. <ab...@un...> - 2012-04-01 12:30:55
|
Hi Martin, On 2012/04/01 09:28, mkk1 wrote: > The patch for generating this documentation. Patch is against the current > trunk. > I added some code from your patch. > http://old.nabble.com/file/p33544964/svn_patch.patch svn_patch.patch I'm not sure how your patch prevents the multiple instances all being generated for the inheritance tree... Whenever I allowed multiple instances to be added to the instFiles list, it would create multiple "inheritances" in the tree... I haven't tried your path though, will try in the coming days. Regards Robert |