Re: [eigen] New Developer Documentation wiki page |
[ Thread Index |
Date Index
| More lists.tuxfamily.org/eigen Archives
]
- To: eigen@xxxxxxxxxxxxxxxxxxx
- Subject: Re: [eigen] New Developer Documentation wiki page
- From: Benoit Jacob <jacob.benoit.1@xxxxxxxxx>
- Date: Wed, 30 Jun 2010 15:21:45 -0400
- Dkim-signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=gamma; h=domainkey-signature:mime-version:received:received:in-reply-to :references:date:message-id:subject:from:to:content-type :content-transfer-encoding; bh=12XVacEDxZwPZlTmYjbD7n7b/+P8lStGaQGXxlz5dis=; b=EgyUV2KOdnaFahpQNe2OWJQ9tRO0lEZ4D2rljHGqx1hS+KM6MtPWA10zGE6zVf+uzI ly5730CLQa2H2gX48eAwDza/6RsOkm7s2a222lc9zO5mpmZ585yuOUSF2WN6n6SwwdAp 0j8AzIGSnuqSt6hhPzjkpMbrhbyCbwvV8k4YU=
- Domainkey-signature: a=rsa-sha1; c=nofws; d=gmail.com; s=gamma; h=mime-version:in-reply-to:references:date:message-id:subject:from:to :content-type:content-transfer-encoding; b=SwIurvpPApR1ARN6dT2lF8QyRs090parGI2+weuyfXTdDkHCz5G9OF/OrbRK6kKJLm F0atWZIvUBT/VBJDzaX7235QseRNBzEmtBTeNZvd7WDQt8NmkjZCcmxCiGXG3xHOoR85 351cIzpp4JZHSRP9juj/oSYY3GROpsjmG/Czc=
Hi,
Great initiative, two comments:
- this is really something that needs to go into doxygen, for a few
reasons, the biggest reason being that such internal things can vary
from version to version, and the doxygen docs are specific to a given
revision of eigen, while the wiki isn't. So having this in doxygen is
much more long-term sustainable.
- for the graphs, we need something better than storing PNGs, for
example I wanted to add "direct access case" in the Matrix column and
I couldn't. I don't know what to use. It might be that doxygen allows
us to do arbitrary graphs. I'd look at that first... A second choice
would be inline HTML: I don't know, but HTML might allow to do this
easily (without using HTML5 canvas ;-) ) a third choice would be
inline LaTeX but the result is a bitmap.
Benoit
2010/6/30 Manoj Rajagopalan <rmanoj@xxxxxxxxx>:
> Hi eigen developers,
>
> Based on detailed replies from Gael and Benoit, I've created a new developer
> documentation wiki page. The page itself is at:
>
> http://eigen.tuxfamily.org/index.php?title=Eigen3_Developer_Documentation
>
> and a link to it is available from the Developer's corner page under the
> section "Eigen hacking":
>
> http://eigen.tuxfamily.org/index.php?title=Developer%27s_Corner#Developer_Documentation
>
> Right now I thought it would be a good idea to save the explanations the
> developers provide and to organize it later on as and when more information
> accumulates.
>
> Thanks,
> Manoj
>
>
>