| Re: [eigen] Patch to AlignedBox |
[ Thread Index |
Date Index
| More lists.tuxfamily.org/eigen Archives
]
- To: eigen@xxxxxxxxxxxxxxxxxxx
- Subject: Re: [eigen] Patch to AlignedBox
- From: Gael Guennebaud <gael.guennebaud@xxxxxxxxx>
- Date: Wed, 24 Oct 2012 10:42:24 +0200
- Dkim-signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113; h=mime-version:in-reply-to:references:from:date:message-id:subject:to :content-type:content-transfer-encoding; bh=3Jh1eQwMkB1m6/JyhHxQA+2rqaKoYneY2ZT4kj4yqKA=; b=ylUQ2FljXL7nm5Q/Kkj8SjwibMVfSUZwpXaJgT+xPOjtyFAElFpGlbadTqB+Dps+D8 bpNmznNZ41oCfz/kf9fPcc06bSeKj4FmTr1l1+1MqDVndvp3CpZroqUHkI3QAH6xNlWr ZHM30ePZV3wICrVem16PAsx/CRop0NgD1tN80vZqHe7XVXXb+HODfF2PnrwMTt2IH1+F 2m5sOZ6j+v9hk1Ou5GqnrKUlRlIkRQyJSZEuPbauwCZuCCOAJvSgD4a2t/xL9pTg7wKG wpVoOUq93fNAetgS+tMd1tG14U50kgnrgiZ03MLN2s7rpWK2NJ7AtBBnGNyJXYOHxqSO aPKQ==
sorry for taking so long to respond.
On Mon, Oct 15, 2012 at 10:53 AM, Wood, Tobias <tobias.wood@xxxxxxxxx> wrote:
>>> Is there some way to mark the old names as deprecated, beyond a comment in the code and note in the documentation?
>>
>> in the doc use \deprecated, and in the code there is a
>> EIGEN_DEPRECATED macro, but it won't work for individual enum name, so
>> we can only mark it in the doc.
> I'm having a couple of problems with Doxygen.
>
> 1. The \deprecated command seems to just remove the following paragraph, it doesn't show up in the generated docs.
strange, they should still appear in the doc.
> 2. Doxygen doesn't seem to have a good mechanism for documenting groups within an enum. If you look at the current docs on the website, only the first member of each group (1D, 2D and 3D) is actually listed with a description. You can get Doxygen to document each member by using groups and setting DISTRIBUTE_GROUP_DOC = YES in the Doxyfile, but this just repeats the group description for every member, which looks terrible!
I think this is still better than the current situation!! So I'd go for it.
cheers,
gael
> There doesn't seem to be any way to get Doxygen to list all the enum members with a single description line, which is what I was trying to get. Does anyone with more experience of Doxygen know how to do this?
>
> Thanks,
> Toby
>
>
>
>
>