On Fri, Feb 20, 2009 at 7:20 AM, Simonson, Lucanus J <lucanus.j.simonson@intel.com> wrote:
I have noticed after attempting to document my overloaded template functions in doxygen that is simply doesn't work. Doxygen appears to consider all SFINAE overloads of a templated function as a single function, but doxygen's treatment of them is quite erratic. It seems to generally have a bunch of assumptions built into its internal logic about what can't happen in C++ code that aren't valid in my case. Does anyone have any suggestions for how to deal with these issues? I notice that doxygen is used with BoostBook, and I know this must have come up in other libraries. How is it solved?
Thanks, Luke
Try the following: use \cond ... \endcond around code which you want Doxygen to ignore. Use #ifdef DOXYGEN_ONLY ... #endif around code formatted specially for Doxygen which you want the compiler to ignore. Tell Doxygen to predefine DOXYGEN_ONLY. Yechezkel Mett