Skip to content

Avoid warnings when generating Doxygen docu

Submitted by Christoph Hertzberg

Assigned to Nobody

Link to original bugzilla bug (#998)
Version: 3.3 (current stable)

Description

First steps might be to look for

#ifndef EIGEN_PARSED_BY_DOXYGEN

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.

Depends on

#728 #833

Blocking

#138