After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 406027 - Templated class member specialization cannot be documented
Templated class member specialization cannot be documented
Status: RESOLVED FIXED
Product: doxygen
Classification: Other
Component: general
1.5.1
Other Linux
: Normal normal
: ---
Assigned To: Dimitri van Heesch
Dimitri van Heesch
Depends on:
Blocks:
 
 
Reported: 2007-02-09 08:44 UTC by Adam Piątyszek
Modified: 2015-06-27 19:02 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
Doxygen configuration file (50.71 KB, text/plain)
2007-02-09 08:45 UTC, Adam Piątyszek
Details
test.h (1.46 KB, text/plain)
2007-02-09 08:45 UTC, Adam Piątyszek
Details
test.cc (197 bytes, text/plain)
2007-02-09 08:46 UTC, Adam Piątyszek
Details

Description Adam Piątyszek 2007-02-09 08:44:37 UTC
Hi!

Here is a short example of a C++ templated class with a specialized member function:

#include <iostream>

template<typename T>
class A {
public:
  //! Default constructor
  A(): a(T(0)) {}
  //! Default destructor
  ~A() {}
  //! Set method
  void set(const T& a_in);
private:
  T a;
};

template<typename T>
void A<T>::set(const T& a_in)
{
  std::cout << "set(T)\n";
  a = a_in;
}

//! Specialization of \c set() with \c int
template<> 
void A<int>::set(const int& a_in);


The problem is that the Doxygen have problems with documenting the specialized set() method. Here is the warning generated:

/home/ediap/c_cpp/doxytest/test.h:57: Warning: Member set(const int &a_in) (function) of class A is not documented.

The problem can be confirmed with Doxygen 1.4.7 and 1.5.1 (latest stable).
Thanks for your help in solving this issue!

BR,
/Adam

PS. Please find the attached source files (test.h, test.cc) and the Doxygen configuration used in this test.
Comment 1 Adam Piątyszek 2007-02-09 08:45:13 UTC
Created attachment 82207 [details]
Doxygen configuration file
Comment 2 Adam Piątyszek 2007-02-09 08:45:45 UTC
Created attachment 82208 [details]
test.h
Comment 3 Adam Piątyszek 2007-02-09 08:46:14 UTC
Created attachment 82209 [details]
test.cc
Comment 4 Oldrich Jedlicka 2013-03-28 07:37:04 UTC
Same here, problem persists with the latest 1.8.3.1.
Comment 5 Pauli 2015-04-05 13:19:15 UTC
Fix was merged to the master (claims to be 1.8.9.1)

https://github.com/doxygen/doxygen/commit/9e97f3ef6952ab981123448e897d5f28d66cd8bd
Comment 6 Dimitri van Heesch 2015-06-27 19:02:05 UTC
This bug was previously marked ASSIGNED, which means it should be fixed in
doxygen version 1.8.10. Please verify if this is indeed the case. Reopen the
bug if you think it is not fixed and please include any additional information 
that you think can be relevant (preferably in the form of a self-contained example).