New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Inherited member of template class issues warning and is not documented (Origin: bugzilla #722654) #5411

Closed
doxygen opened this Issue Jul 2, 2018 · 0 comments

Comments

Projects
None yet
1 participant
@doxygen
Owner

doxygen commented Jul 2, 2018

status VERIFIED severity normal in component documentation for ---
Reported in version 1.8.7 on platform Other
Assigned to: Dimitri van Heesch

On 2014-01-20 21:15:10 +0000, J. P. Abelanet wrote:

Doxygen 1.8.6 issues warnings about and does not document inherited members of template classes (this did not occur in 1.8.0):

/private/var/tmp/doxy_undoc_declaration_test/ERLB.h:8: warning: Member Contains(const Fred *entity) const (function) of class EntityReferenceListBase< Fred > is not documented.

Below is a simple example which fails using the auto-generated Doxyfile.


/**
This is the base class...
*/
template
class EntityReferenceListBase {

public:
inline bool Contains (const T *entity) const;
};

template
inline bool EntityReferenceListBase::Contains (const T entity) const
/
*
This routine determines if an Entity is in a list of Entities.
*/
{
}

/**
This is the derived class...
*/
class EntityReferenceList: public EntityReferenceListBase {
};

}

On 2014-01-20 21:17:08 +0000, J. P. Abelanet wrote:

Note that this works if the member is defined (and documented) in the body of the template class, rather than outside it.

On 2014-06-22 14:25:32 +0000, J. P. Abelanet wrote:

Verified that this does not work in 1.8.7.

This is a real problem as it affects most of the documentation of a large project we have.

On 2015-12-22 18:16:07 +0000, J. P. Abelanet wrote:

This still occurs with 1.8.10. Would you mind taking a look at this? Thanks.

On 2015-12-24 13:00:41 +0000, albert wrote:

Looks to me that this problem has been solved by the last updates in github.

I think this bug report can be set to ASSIGNED

On 2015-12-29 21:01:30 +0000, J. P. Abelanet wrote:

Just tried 1.8.11 via git, and the problem is worse. It no longer complains, but the inherited public methods do not appear at all now.

On 2016-01-09 15:35:51 +0000, Dimitri van Heesch wrote:

Confirmed. Should be fixed in the next GIT update.

On 2016-01-11 16:18:00 +0000, J. P. Abelanet wrote:

Just did a git pull and clean build, and I still get this:

/Users/jp/GE/BUGS/1574/ERLB.h:8: warning: Member Contains(const Fred *entity) const (function) of class EntityReferenceListBase< Fred > is not documented.

Did I miss something when updating via git?

On 2016-01-11 17:55:43 +0000, albert wrote:

There has not been an git updated yet (only a pull request has been added to git)

On 2016-01-11 18:02:12 +0000, J. P. Abelanet wrote:

I apologize - I don't use git on a regular basis.

On 2016-01-18 16:49:33 +0000, J. P. Abelanet wrote:

Confirmed that 1.8.12 (git) now fixes the problem - thanks.

On 2016-09-05 13:45:57 +0000, Dimitri van Heesch wrote:

This bug was previously marked ASSIGNED, which means it should be fixed in
doxygen version 1.8.12. 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).

On 2016-09-06 20:24:25 +0000, J. P. Abelanet wrote:

Verified - thanks!

@doxygen doxygen closed this Jul 19, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment