Re: [Boost-docs] Doxygen features

Subject: Re: [Boost-docs] Doxygen features
From: Bo Jensen (jensen.bo_at_[hidden])
Date: 2010-06-28 10:24:50

Enums also seems not to be supported, is this correct ? Is there a
list of currently supported features for the doxygen convertion ?

On Mon, Jun 14, 2010 at 3:06 PM, Bo Jensen <jensen.bo_at_[hidden]> wrote:
> Sorry for being a pain :-) But I have a couple of other small issues.
>
> 1) The parameters list seem to get sorted after name in the conversion
> to boostbook and makes it hard to read. It is correctly ordered in my
> .doxygen file. I have set :
>
>        :
>        <doxygen:param>SORT_MEMBER_DOCS=NO
>        <doxygen:param>SORT_BRIEF_DOCS=NO
>
> which I am a little unsure is actually used.
>
> 2) I also would like to have a linebreak after each function input name i.e :
>
> void somefunction(int arg1,
>                           int arg2,
>                           ....
>                           int argj)
>
> Otherwise it is confusing to match up the arguments with the parameter
> list. Not sure if this is a doxygen issue or not though. Is this
> possible with some setting or is it not implemented ?
>
> Actually I think this should be the last two issues I have (i hope),
> it looks great otherwise :-)
>
> On Sun, Jun 13, 2010 at 10:42 PM, Bo Jensen <jensen.bo_at_[hidden]> wrote:
>> Daniel, thank you for providing a patch. It is not completely correct
>> yet, in the overview section I get :
>>
>> void somefunction(int [])
>>
>> which is correct, but in the detailed section I get :
>>
>> void somefunction(int [] somearray)
>>
>> so the [] should be shifted to position after the argument name.
>>
>> Did this patch also include a fix for see also links ?
>>
>>
>> On Sun, Jun 13, 2010 at 10:34 AM, Daniel James <dnljms_at_[hidden]> wrote:
>>> I've attached a new patch. It turns out that there are several edge
>>> cases to deal with. Sorry it took a while.
>>>
>>> On 1 June 2010 02:34, Steven Watanabe <watanabesj_at_[hidden]> wrote:
>>>>>
>>>>
>>>> I'm not sure that it has to be perfect.  Doxygen
>>>> generates gibberish for some of the complicated
>>>> tests I tried, anyway.
>>>
>>> There's another problem, 'type' elements sometimes contain other
>>> elements (such as links) which would make this trickier. The only
>>> solution I can think of, is to parse the text, work out the offset for
>>> where to insert the variable name and then walk through the elements,
>>> counting to find the insert position as they're written out. It's
>>> quite convoluted. Do you have any better ideas?
>>>
>>> Daniel
>>>
>>> _______________________________________________
>>> Boost-docs mailing list
>>> Boost-docs_at_[hidden]
>>> http://lists.boost.org/mailman/listinfo.cgi/boost-docs
>>>
>>>
>>
>