Re: Quickbook links to functions with the same name but different parameter lists

> -----Original Message-----
> From: Boost-docs [mailto:[email protected]] 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 <[email protected]> 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.
> >
> > 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 say that having no way specify a value with a space in it is a design bug/flaw. I'm not sure
how to fix it
> though. We could adapt the template convention of (optionally) separating arguments with '..', or
use
> square brackets with an appropriate symbol (e.g. [=some text] would be a single argument of value
> 'some text' i.e. a no-op element), or just use quotes (not very consistent though).

Abuse of layout is a feature, not a bug ;-)

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

Quickbook/Doxygen/AutoIndex chain works to produce what I think are some really nice docs.

There are some weakness in Doxygen's understanding of C++, but now that code from Clang is being
used, it should get better.

Paul


---
Paul A. Bristow,
Prizet Farmhouse, Kendal LA8 8AB  UK
+44 1539 561830  07714330204
[email protected]