This bugzilla service is closed. All entries have been migrated to
Bug 998 - Avoid warnings when generating Doxygen docu
Summary: Avoid warnings when generating Doxygen docu
Alias: None
Product: Eigen
Classification: Unclassified
Component: Documentation (show other bugs)
Version: 3.3 (current stable)
Hardware: All All
: Low Documentation
Assignee: Nobody
Keywords: JuniorJob
Depends on: 728 833
Blocks: 138
  Show dependency treegraph
Reported: 2015-04-16 11:18 UTC by Christoph Hertzberg
Modified: 2019-12-04 14:31 UTC (History)
4 users (show)


Description Christoph Hertzberg 2015-04-16 11:18:33 UTC
First steps might be to look for 
and replace them by simple \internal tags -- except for cases where the code is too complicated for Doxygen.
Also, some deprecated (unused) code samples can be dropped.

You can configure Eigen with -DEIGEN_TEST_BUILD_DOCUMENTATION=ON to have the documentation built when building the test-suite, and you can activate EIGEN_INTERNAL_DOCUMENTATION if you want the \internal documentation to be built.

Bug 728 and Bug 833 should probably be solved along with this.

Overall, this is not super-important but should be done eventually.
Comment 1 Christoph Hertzberg 2015-05-01 20:15:48 UTC
I started fixing some warnings (only on devel branch so far):

A major issue at the moment is that doxygen does not like template specializations, most importantly that makes documenting TriangularView difficult, because doxygen does not know if it should inherit from TriangularViewImpl<...,Dense> or TriangularViewImpl<...,Sparse>.
Comment 2 Nobody 2019-12-04 14:31:36 UTC
-- GitLab Migration Automatic Message --

This bug has been migrated to's GitLab instance and has been closed from further activity.

You can subscribe and participate further through the new bug through this link to our GitLab instance:

Note You need to log in before you can comment on or make changes to this bug.