This bugzilla service is closed. All entries have been migrated to https://gitlab.com/libeigen/eigen
Bug 728 - Make code-generation macros visible to doxygen
Summary: Make code-generation macros visible to doxygen
Status: CONFIRMED
Alias: None
Product: Eigen
Classification: Unclassified
Component: Documentation (show other bugs)
Version: 3.3 (current stable)
Hardware: All All
: Normal Documentation
Assignee: Nobody
URL:
Whiteboard:
Keywords:
Depends on: 339
Blocks: 998
  Show dependency tree / graph
 
Reported: 2014-01-20 18:16 UTC by Gael Guennebaud
Modified: 2019-12-04 12:56 UTC (History)
4 users (show)


Attachments
Add an attachment (proposed patch, testcase, etc.)

Description Gael Guennebaud 2014-01-20 18:16:10 UTC 
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"
Comment 1 Jitse Niesen 2014-01-20 19:52:24 UTC 
Does this indeed help the documentation? If so, I'm all in favour. I don't consider it any uglier as macros.
Comment 2 Christoph Hertzberg 2014-03-01 02:58:33 UTC 
It does work if you #include "util/Macros.h" from all files which use it, and add EIGEN_DENSE_PUBLIC_INTERFACE into the EXPAND_AS_DEFINED list (in Doxyfile.in).
Comment 3 Nobody 2019-12-04 12:56:53 UTC 
-- GitLab Migration Automatic Message --

This bug has been migrated to gitlab.com'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: https://gitlab.com/libeigen/eigen/issues/728.
Note You need to log in before you can comment on or make changes to this bug.