New user self-registration is disabled due to spam. Please email eigen-core-team @ lists.tuxfamily.org if you need an account.
Before reporting a bug, please make sure that your Eigen version is up-to-date!
Bug 138 - Write more developer documentation
Summary: Write more developer documentation
Status: CONFIRMED
Alias: None
Product: Eigen
Classification: Unclassified
Component: Documentation (show other bugs)
Version: unspecified
Hardware: All All
: Highest Documentation
Assignee: Nobody
URL:
Whiteboard:
Keywords:
Depends on: 46 81 111 339 457 998 ExprEval
Blocks: 3.x
  Show dependency treegraph
 
Reported: 2010-12-18 14:55 UTC by Benoit Jacob
Modified: 2018-10-09 19:39 UTC (History)
5 users (show)



Attachments

Description Benoit Jacob 2010-12-18 14:55:37 UTC
3.0 won't have great developer documentation as we need it released ASAP, let's not miss the train on 3.1.

This depends on a few deep internal changes needed for 3.1, which would make obsolete parts of developer docs written until now.
Comment 1 Gael Guennebaud 2012-03-26 18:14:12 UTC
sadly we missed it :(
Comment 2 Christoph Hertzberg 2012-04-02 13:01:50 UTC
Is there a rush in releasing 3.1 at the moment?

And more importantly, has anyone even remotely started thinking about working on this issue? Otherwise, I can almost guarantee that you will miss it again for 3.2 :(

Over the years I'm using Eigen, I more-or-less find most things in the Eigen code with reasonable effort, but I'm afraid that I'm too far from being able to document it (especially, I don't understand every internal design decision, etc).

Furthermore, solving bug 339 (self contained headers) would make things much easier already. This would not be much effort (and could easily be done before releasing 3.1), though it could raise many conflicts if done non-coordinated.
Comment 3 Benoit Jacob 2012-04-02 15:31:56 UTC
Also, installing a DXR instance would considerably help navigating the source tree!

See e.g.
http://dxr.lanedo.com/
Comment 4 Jitse Niesen 2012-04-03 16:43:45 UTC
(In reply to comment #2)
> And more importantly, has anyone even remotely started thinking about working
> on this issue? Otherwise, I can almost guarantee that you will miss it again
> for 3.2 :(

The plan is (or at least it was a year ago) to finish the work on evaluators (bug 99) first and then write developer documentation. The idea is that it would not make sense to write docs that will be soon out of date; evaluators represent a fairly drastic re-design of the Eigen core.

Unfortunately, a year later we found that not a lot of progress has been made on evaluators.
Comment 5 Christoph Hertzberg 2012-04-03 17:19:38 UTC
(In reply to comment #4)
> The plan is (or at least it was a year ago) to finish the work on evaluators
> (bug 99) first and then write developer documentation. The idea is that it
> would not make sense to write docs that will be soon out of date; evaluators
> represent a fairly drastic re-design of the Eigen core.
> 
> Unfortunately, a year later we found that not a lot of progress has been made
> on evaluators.

ok, fair enough. Still it would be a first step to solve bug 339 (and install a DXR for people who like it -- I myself prefer not switching between browser and IDE for developing).
And actually, the same question remains w.r.t. bug 99, is there somebody actively working on it? 
And is there some documentation about evaluators somewhere besides in the corresponding BZ thread (either as they are now or they intend to be)? That would be helpful if you want others to contribute to that task.
Comment 6 Christoph Hertzberg 2013-06-11 13:01:57 UTC
I increased the importance to "normal" (although it actually could be even higher) and added some more dependencies.
Comment 7 Christoph Hertzberg 2014-07-18 14:49:24 UTC
I added a EIGEN_INTERNAL_DOCUMENTATION flag to build the \internal parts of the documentation (without manually changing the generated Doxyfile):

https://bitbucket.org/eigen/eigen/commits/090787aa84

We could set even more flags in the Doxyfile if that option is enabled, and maybe we could automatically build and upload that (though it's not really of public interest)

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