Skip to content
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

Data/return type concatenated to variables/function name #655

Closed
RazailaAlexandra opened this issue Mar 9, 2021 · 5 comments
Closed

Data/return type concatenated to variables/function name #655

RazailaAlexandra opened this issue Mar 9, 2021 · 5 comments
Assignees
Labels
upstream Issue in external software

Comments

@RazailaAlexandra
Copy link

Hello!
I tried to generate documentation file for a C++ project using breathe, but on the .html page the returned type is concatenated to the function name and so are the type of parameters and their name.
Version used: Breathe=4.27.0, Sphinx=3.5.1, Python=3.6.7, Doxygen=1.9.1
Here is a short example:
docFunc
I would like it to look like this:
void say_hello(std:string message)const

I attached an example of project to can see the problem:
exampleProject.zip

@jakobandersen
Copy link
Collaborator

There are two other spaces missing in the declaration as well, rather annoying. I have previously seen this issue, but only with the readthedocs theme. It seems like they have an open issue with this readthedocs/sphinx_rtd_theme#694.

@RazailaAlexandra
Copy link
Author

Thank you for your answer.
Do you know about any workaround for this issue?

@jakobandersen
Copy link
Collaborator

Unfortunately not immediately, I don't use readthedocs my self.

@jakobandersen
Copy link
Collaborator

As discussed in #628, this issue seems to accidentally be resolved (for C++) if sphinx-doc/sphinx#9023 gets merged.

@vermeeren vermeeren self-assigned this Mar 29, 2021
@vermeeren vermeeren added the upstream Issue in external software label Mar 29, 2021
@vermeeren
Copy link
Collaborator

Going to close this one at the Breathe side in an attempt to tidy up the issue tracker a bit, thanks for upstream work as always @jakobandersen !

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
upstream Issue in external software
Projects
None yet
Development

No branches or pull requests

3 participants