IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Fixed a C++ bug that caused bad references to be generated. This also

Browse Source 
adds a note on overloads always ending up on the first version of the
method in case more than one is defined.
This commit is contained in:
Armin Ronacher
2010-05-30 13:51:50 +02:00
parent 35f0b555a4
commit 475c3ba93b
2 changed files with 19 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
doc/domains.rst
View File

@@ -511,6 +511,15 @@ These roles link to the given object types:
Reference a C++ object. You can give the full signature (and need to, for
overloaded functions.)
.. admonition:: Note on References
It is currently impossible to link to a specific version of an
overloaded method. Currently the C++ domain is the first domain
that has basic support for overloaded methods and until there is more
data for comparison we don't want to select a bad syntax to reference a
specific overload. Currently Sphinx will link to the first overloaded
version of the method / function.
The Standard Domain
-------------------