For each class X, we have a typedef Xs which is more or less an
std::vector<X> and is used to transfer lists of Xs around. As far as I can
tell, I currently have the choice of either exposing these typedefs to
doxygen, in which case
- half of the names shown in various lists (eg namespace contents) are
these low information content names
- to get to the actual interesting part of what is being returned by a
function returned Xs, one has to click through a couple of times
- python users see things about typedefs and std::vector which they don't
really know about (we have swig interfaces generated from the C++ code)
or I can hide the typedefs from doxygen (and document the general pattern)
in which case
- my lists of types are much shorter
- there are no links from things that take or return Xs to the class X.
or I can use \relates on the typedef which works perfectly as the typedef
is moved to the class page, but
- the doxygen documentation implies it shouldn't work
- it is called a related function in the docs
It seems to me that being able to tell doxygen something like "when you see
symbol Xs, generate a link to X" would solve the problem nicely, but I'm
not seeing a way to do that. Or have \related be documented to work with
typedefs. Do people have other alternatives for this case?
Thanks.
------------------------------------------------------------------------------
Live Security Virtual Conference
Exclusive live event will cover all the ways today's security and
threat landscape has changed and how IT managers can respond. Discussions
will include endpoint security, mobile security and the latest in malware
threats. http://www.accelacomm.com/jaw/sfrnl04242012/114/50122263/
_______________________________________________
Doxygen-users mailing list
Doxygen-users@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/doxygen-users
