-
-
Notifications
You must be signed in to change notification settings - Fork 2.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Cross-referencing a function that returns a pointer with :cpp:func: causes error "Invalid definition: Expected end of definition" #6208
Comments
Thanks for reporting, this is indeed a bug. Note though that there are two formats for function references: (1) a full signature (as you write), for referencing a specific overload, and (2) just the name of the function (here |
Hi Jakob, thanks for taking a look at the issue. I can confirm that the format (2) you described works as intended, and even most full signatures work correctly with the exception of functions that return pointers. |
This should be fixed in version 2.0.1. |
Describe the bug
While using the :cpp:func: directive to cross-reference a C++ function that returns a pointer, you will receivean error that the * character in the reference is "unparseable". This makes it impossible to cross-reference a function with a pointer return value
To Reproduce
Steps to reproduce the behavior:
Source (C++):
Sphinx (reStructuredText):
Result:
Expected behavior
The expected behavior is to output a properly cross-referenced link to the Foo* Foo::Bar() function.
Your project
N/A
Screenshots
N/A
Environment info
The text was updated successfully, but these errors were encountered: