Re: [Boost-docs] Quickbook links to functions with the same name but different parameter lists

Subject: Re: [Boost-docs] Quickbook links to functions with the same name but different parameter lists
From: Daniel James (daniel_at_[hidden])
Date: 2013-05-29 11:36:02

On 29 May 2013 12:16, Paul A. Bristow <pbristow_at_[hidden]> wrote:
>
>
>> -----Original Message-----
>> From: Boost-docs [mailto:boost-docs-bounces_at_[hidden]] On Behalf Of Daniel James
>> Sent: Wednesday, May 29, 2013 11:47 AM
>> To: Discussion of Boost Documentation
>> Subject: Re: [Boost-docs] Quickbook links to functions with the same name but different parameter
> lists
>>
>> On 29 May 2013 08:55, Paul A. Bristow <pbristow_at_[hidden]> wrote:
>> >>
>> >> Quickbook uses spaces as a separator, and doesn't have a good way of
>> >> quoting values, so I don't
>> > think
>> >> there's much that can be done here.
>> >> Not in the short term anyway. But doesn't really matter if the boostbook support is there.

I meant to say it doesn't matter if the boostbook support isn't there.

>> >
>> > Yes - fine - a feature not a bug.   Might be worth documenting, but it's pretty obvious what to
> do
>> > if you meet it.
>
> [memberref boost::mylibrary::myclass::test_me(int, const char*)
> boost::mylibrary::myclass::test_me(int, const char*)]
>
> worked OK for me .

I'd expect quickbook to generate the the link text 'const char*)
boost::mylibrary::myclass::test_me(int, const char*)' which isn't
right.

> As I have observed before having a space/tab to signal a code section seems a bit odd to me, but
> there you go.

It is consistent with the rest of quickbook. I suppose we could parse
the function in quickbook (I think it'd just really need to understand
angle and round brackets), but I'm trying to make quickbook more
consistent and am weary of a special case parse.