GNOME Bugzilla – Bug 153376
documentation of template parameters should be possible
Last modified: 2008-02-10 13:03:13 UTC
[forwarded from http://bugs.debian.org/227864] When writing documentation about C++ templates it should be possible to describe the fuctionality of template parameters like with @param.
Actually, this bug appears related to the number of angle-brackets in the parameter list. One set is okay (see bottom function), but two sets cause it to miss @param calls, whether it's one nested template parameter or two separate template parameters. This is a simplification of some code that exhibits the problem, but I don't have time to make it go through Doxygen at the moment. When I put it in a working .cpp file, it fails to produce anything at all for the whole file. /// Something about class class Class { bool isEqual(std::vector<int> const &ids, std::vector<int> const *foos) const; void interpolate(std::vector<std::pair<int, float> > const &ids, int const newId, std::vector<int> const *foos); void deleteId(int const id, std::vector<int> const *foos); }; /// @param ids some ids /// @param foo some foos bool Class::isEqual(std::vector<int> const &ids, std::vector<int> const *foos) const { // this fails to locate parameters } /// @param ids several ids /// @param newId new id /// @param foos some foos void Class::interpolate(std::vector<std::pair<int, float> > const &ids, int const newId, std::vector<int> const *foos) { // this fails to locate parameters } /// @param id identify my foos /// @param foos my foos void Class::deleteId(int const id, std::vector<int> const *foos) { // this SUCCEEDS in locating parameters }
In the next release, I will include a new command, called @tparam (or <typeparam>..</typeparam> if you prefer C# XML syntax) to document template parameters.
Sweet! This has been my #1 wish for Doxygen for a while. Thanks!
This bug was marked assigned, which means to should be fixed in version 1.5.5 of doxygen. Please verify if this is indeed the case, and if not, reopen the bug and provide additional information if possible.