| Re: [eigen] Proposal: documentation for Eigen3 |
[ Thread Index |
Date Index
| More lists.tuxfamily.org/eigen Archives
]
- To: eigen@xxxxxxxxxxxxxxxxxxx
- Subject: Re: [eigen] Proposal: documentation for Eigen3
- From: Benoit Jacob <jacob.benoit.1@xxxxxxxxx>
- Date: Sat, 5 Jun 2010 11:25:38 -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; bh=AnCENUXtGrFQs7le3zolLtMr99D9Pl1j1ArY3FwNEws=; b=vOJwM+uTcBdixB4uMRpeg5pp5hfrwfjgZW1jB+1GGOGCmjWpcxg8NK95N0zYnYYFnv CtC3XHDmV40USJjukgbWULyyMElQlfz3B8n6OWyWuH0ztXmlq4ZIFe5ywShPsRuiUdbH qPQ3SknTSgrpFdyUxgZN76zzRqFQs1vS/8JuA=
- 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; b=fWw9AO+6zigNPdDGiDgA80vg7twIvYP78JCqVE8fmF5dH+RAGvfHkOJKpnDTwgt8hX Yru0qCa7VCYt7XvyzWm6sSVSXEIb0ZBA6DL8HPJycpecOHLi0PLHWL2fUn9eolHtN3Gn o4GQjdqhMl165JzvW2gnygJR7cJWwECGm0Ep4=
Maybe, eventually we'll write a "book", a "reference manual" for Eigen
in something else than doxygen.
For now, doxygen has a great advantage, also in the tutorials, it's
that it makes it easy to link to doxygen-generated class and method
documentation. Plus of course the fact that we don't have time right
now to investigate other docs options --- maybe at a later time.
I agree that doxygen is far from perfect.
Benoit
2010/6/5 joel falcou <joel.falcou@xxxxxx>:
> I can only suggest you to keep the doxygen for technical doc and use a real
> authoring stuff liek sphinx or quickbook and write a proper doc by hand next
> to the tech doc ;)
>
>
>