Solution (?) to Warning from <unknown>:1 on inheritance from template instantiations

classic Classic list List threaded Threaded
1 message Options
Reply | Threaded
Open this post in threaded view
|

Solution (?) to Warning from <unknown>:1 on inheritance from template instantiations

Marcin Kasperski
I faced and found workaround (which I'd like to share) for the problem
previously discussed some time ago:
   https://sourceforge.net/p/doxygen/mailman/message/31040993/
In short, code like
    /** … **/
    class SomeClass : public SomeTemplate<Arg>
    {
        …
    };
where SomeTemplate is template class defined in separate library
(accessible via TAGFILES)
generates various warnings like
   <unknown>:1: warning: Member ……… of class SomeTemplate<Arg> is not documented
(for various methods of SomeTemplate)

Apart from warnings it causes undocumented methods showing up.


Looks like the following workaround works fairly nicely:

   // workaround for doxygen problems on inheritance from templates
   /**
       @class SomeTemplate<Arg>
       @extends SomeTemplate
   **/

    /** … **/
    class SomeClass : public SomeTemplate<Arg>
    {
        …
    }

Warnings are gone, inherited methods show up, inheritance chain shows
SomeClass <- SomeTemplate<Arg> <- SomeTemplate
what is in fact logical

(I tested on doxygen 1.8.6)

------------------------------------------------------------------------------
What NetFlow Analyzer can do for you? Monitors network bandwidth and traffic
patterns at an interface-level. Reveals which users, apps, and protocols are
consuming the most bandwidth. Provides multi-vendor support for NetFlow,
J-Flow, sFlow and other flows. Make informed decisions using capacity
planning reports. https://ad.doubleclick.net/ddm/clk/305295220;132659582;e
_______________________________________________
Doxygen-users mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/doxygen-users