Bug 456

Summary: doxygen introspection for trace source config paths is wrong
Product: ns-3 Reporter: Tom Henderson <tomh>
Component: documentationAssignee: ns-bugs <ns-bugs>
Status: RESOLVED FIXED    
Severity: normal CC: faker.moatamri, mathieu.lacage
Priority: P1    
Version: ns-3-dev   
Hardware: All   
OS: All   
Attachments: html doxygen file that was not supposed to show correctly

Description Tom Henderson 2008-12-30 16:14:38 UTC
Paths for trace sources are not being documented correctly in doxygen.

For instance, the doxygen says:

This object is accessible through the following paths with Config::Set and Config::Connect:

    * /NodeList/[i]/$ns3MobilityModel

but it should say:

This object is accessible through the following paths with Config::Set and Config::Connect:

    * /NodeList/[i]/$ns3::MobilityModel


This comment is in the print-introspected-doxygen.cc file:
          // Note: we insert a % in the path below to ensure that doxygen does not
          // attempt to resolve the typeid names included in the string.
          m_currentPath.push_back ("$%" + other.GetName ());


but it seems that Doxygen is dropping the "::" after "ns3".
Comment 1 Faker Moatamri 2009-06-22 10:32:59 UTC
Can you please tell me how can I reproduce the bug. Actually doing ./waf --doxygen generates the doxygen html documentation, where do I need to look click to find the above problem?
Comment 2 Faker Moatamri 2009-06-22 10:59:51 UTC
Created attachment 477 [details]
html doxygen file that was not supposed to show correctly
Comment 3 Faker Moatamri 2009-06-22 11:01:24 UTC
I tried to reproduce the bug and the file looks very well, here is attached a copy of the file please check if you can see it correctly. The version of doxygen that I have is: 1.5.7.1
Regards

Comment 4 Tom Henderson 2009-06-23 00:48:38 UTC
(In reply to comment #3)
> I tried to reproduce the bug and the file looks very well, here is attached a
> copy of the file please check if you can see it correctly. The version of
> doxygen that I have is: 1.5.7.1
> Regards
> 


Faker, I was able to reproduce the bug on the server but only after I fixed the script that was generating the introspection (which was not regenerating after the ./waf --check change).

So, go to http://www.nsnam.org/doxygen/index.html, click on the modules tab, select the "List of all Trace Sources", and you should see the reported behavior.

This is from Doxygen 1.5.6 on www.nsnam.org
Comment 5 Faker Moatamri 2009-06-24 03:49:51 UTC
changeset: 4580:8092e3e83487