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-28 22:45:17

This is all bad news...

On 28 May 2013 09:50, Paul A. Bristow <pbristow_at_[hidden]> wrote:
> [memberref boost::mylibrary::myclass::test_me(float)]

Resolving links to reference documentation is part of boostbook. I
don't know much about it, but I don't think it supports linking to
individual overloads.

> [memberref boost::mylibrary::myclass::test_me(int, const char*)
> boost::mylibrary::myclass::test_me(int, const char*)]

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.

> But I couldn't get a truly global variable to be referenced
>
> int const global_int = 99; // [globalref ::global_int]
>
> but maybe that's because they are non-PC? ;-)

Have you checked that reference documentation for global_int was
actually created? I vaguely recall that it wasn't for doxygen docs for
some reason.

> Nor could I get a link from *class* public (or private) member variables.

I don't think Boostbook has any support for linking to member
variables. 'memberref' actually generates a tag called 'methodref' for
linking to methods. I don't know why it was done that way.