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

Subject: [Boost-docs] Quickbook links to functions with the same name but different parameter lists
From: Paul A. Bristow (pbristow_at_[hidden])
Date: 2013-05-28 08:50:21

[memberref boost::mylibrary::myclass::test_me(float)]
 
Link to boost::
<file:///I:\boost-sandbox\guild\mylibrary\libs\mylibrary\doc\html\boost\mylibrary\myclass.html#id310
479-bb> mylibrary::myclass::test_me(float)
 
[memberref boost::mylibrary::myclass::test_me(double)]
 
link to boost::
<file:///I:\boost-sandbox\guild\mylibrary\libs\mylibrary\doc\html\boost\mylibrary\myclass.html#id310
479-bb> mylibrary::myclass::test_me(double)
 
 
[memberref boost::mylibrary::myclass::test_me(int, const char*)
boost::mylibrary::myclass::test_me(int, const char*)]
 
link to const char*) boost::
<file:///I:\boost-sandbox\guild\mylibrary\libs\mylibrary\doc\html\boost\mylibrary\myclass.html#id310
479-bb> mylibrary::myclass::test_me(int, const char*)
 
It might be worth noting in the docs that
 
If there is a space in member function specification, then need to provide full text, or will just
get
 
"const char*)" as the link text.
 
The consequence warnings don't seem quite right to me? (but that's not important)
 
Reference to method 'boost::mylibrary::myclass::test_me' is ambiguous. Found:
              Match in namespace ::
              Match in namespace ::
Reference to method 'boost::mylibrary::myclass::test_me' is ambiguous. Found:
              Match in namespace ::
              Match in namespace ::
Reference to method 'boost::mylibrary::myclass::test_me' is ambiguous. Found:
              Match in namespace ::
              Match in namespace ::
 
A variable in the boost::mylibrary:: namespace [globalref boost::mylibrary::mylibrary_global]
 
was referenced OK
 
[globalref boost::mylibrary::mylibrary_global]
 
boost::
<file:///I:\boost-sandbox\guild\mylibrary\libs\mylibrary\doc\html\boost\mylibrary\mylibrary_global.h
tml> mylibrary::mylibrary_global
 
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? ;-)
 
Nor could I get a link from *class* public (or private) member variables.
 
[globalref boost::mylibrary::myclass.mypublic_var]
 
[memberref boost::mylibrary::myclass::mypublic_var]
 
[memberref boost::mylibrary::myclass.mypublic_var]
 
[globalref boost::mylibrary::myclass::myprivate_var]
 
Cannot find data-member named 'boost::mylibrary::myclass.mypublic_var'
Cannot find method named 'boost::mylibrary::myclass::mypublic_var'
Cannot find method named 'boost::mylibrary::myclass.mypublic_var'
Cannot find data-member named 'boost::mylibrary::myclass::myprivate_var'
 
What am I doing wrong?
 
Thanks
 
Paul
 
---
Paul A. Bristow,
Prizet Farmhouse, Kendal LA8 8AB  UK
[phone]  07714330204
pbristow_at_[hidden]