Skip to content

Make code-generation macros visible to doxygen

Submitted by Gael Guennebaud

Assigned to Nobody

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

Description

Macros like EIGEN_DENSE_PUBLIC_INTERFACE define a lot of useful types. Unfortunately, despite my attempts, doxygen does not manage to really see what's inside because it does not see the doxygen comments that are inside this macro.

Therefore, I suggest turning these macro as #include, e.g.:

typedef PlainObjectBase<Matrix> Base;

EIGEN_DENSE_PUBLIC_INTERFACE(Matrix)

would become:

typedef PlainObjectBase<Matrix> Base;

typedef Matrix Derived;

#include "../plugins/DensePublicInterface.h"

Depends on

#339

Blocking

#998