|Re: [eigen] Proposal: documentation for Eigen3|
[ Thread Index |
| More lists.tuxfamily.org/eigen Archives
- To: eigen@xxxxxxxxxxxxxxxxxxx
- Subject: Re: [eigen] Proposal: documentation for Eigen3
- From: Rui Maciel <rui.maciel@xxxxxxxxx>
- Date: Sun, 6 Jun 2010 16:22:24 +0100
- Dkim-signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=gamma; h=domainkey-signature:received:received:from:to:subject:date :user-agent:references:in-reply-to:mime-version:content-type :content-transfer-encoding:message-id; bh=rhRTFU6ty2OdLx/KqRat5+esQ5XhY30LvqcuiUtlsC0=; b=WuIdBJgHom4WDImM6m+drismQFbIUHjU5LjS22kcUBxDsWWIOf/UHAbZ63+dtG1KkK 75F3do4hZDWVotQT+Xg8lAfx9CacGGTfwLASJLSRi9T1oqmfUSYakz6DBljc5UAxEdaa Bio3fZ3GwsFlYDdSp/RM4esTfTwd6NMXjrOF8=
- Domainkey-signature: a=rsa-sha1; c=nofws; d=gmail.com; s=gamma; h=from:to:subject:date:user-agent:references:in-reply-to:mime-version :content-type:content-transfer-encoding:message-id; b=ZgpqEIC1d3qCov/DIVzUKQOOyvTCxSX4dz/7dqTcdeNyGW+p9mkLPD8blMuLlmeE5t BxLprmLgg/PTbmiUr6lnVevXg9aEWfUOnqtAZXr6kSK7AtwTyquy3n0zBLZFkVpVmybM WiOsiINKyJO85D1fBIIYwnIlCVJN3CKAgR9GM=
Thomas Capricelli wrote:
> Yes, i was about to say that. I use exactly this (mediawiki + pdf export)
> to generate doc on some other projects, and i'm happy with it.
> Though, still, i'm not sure this would be the right approach for eigen. The
> use of doxygen has proved quite successful until now, and is of far better
> quality than the doc on the wiki.
There's no need to choose between a wiki documentation and a doxygen
reference. Both scratch different itches and both can and do coexist rather
> And i dont buy the argument about wiki database file that can be lost, this
> is easy to backup.. I could do it, and we could setup something on
> tuxfamily, and we could setup something on Benoit or Gael's own hard disk.
> I'm very confident we could do something that makes Benoit happy.
Indeed. I also thought this argument was a bit far-fetched.
> Last, i agree that writing doc for eigen is technical, and it's not sure
> that making it 'easy' (on the wiki) would help. You want people writing
> such technical topic to be fluent in source, hg, and some such easy doc
> tool as (say) doxygen.
It's true that in order to produce documentation, the authors need to know
what they are writing about. Yet, if someone wishes to contribute something
to the documentation then chances are that person already looked into the
source code and found something which, from his experience using Eigen and
fiddling with the source code, he believes deserves to be documented. To put
it in other words, we aren't talking about some clueless newbie who just
parachuted into Eigen's world. If someone intends to contribute to the
documentation then naturally that person already has some experience with it.