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

Line breaks in argument lists #548

Open
harpolea opened this issue Jun 22, 2020 · 2 comments
Open

Line breaks in argument lists #548

harpolea opened this issue Jun 22, 2020 · 2 comments
Labels
enhancement Improvements, additions (also cosmetics) upstream Issue in external software

Comments

@harpolea
Copy link

We've been using breathe to generate documentation for our C++ code, Castro (which works great by the way - thank you!). However, we have a number of functions with fairly long, complex argument lists which are quite difficult to read (e.g. see this example).

We were wondering if there was a way we could tell breathe to e.g. split argument lists so that each argument was on a new line, or to tell it to not split individual arguments across lines? If not, then is this a feature that could be added?

Thanks!

@jakobandersen
Copy link
Collaborator

That is indeed difficult to read, and in the end there probably need to be some changes in Breathe as well, but the main issue is with the capabilities of Sphinx. See sphinx-doc/sphinx#1514 (and related linked issues) for discussions.

@vermeeren vermeeren added enhancement Improvements, additions (also cosmetics) upstream Issue in external software labels Aug 19, 2020
@leofang
Copy link

leofang commented Jan 18, 2024

Q: Is there any update on this?

While the upstream added the maximum_signature_line_length option in v7.1, it doesn't work very well in our project and we had to resort to custom css as suggested here before the upstream fix landed. However, it only works for the cpp domain and not the c domain, for which sig-param items are not generated in the htmls. Any suggestion to move forward?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Improvements, additions (also cosmetics) upstream Issue in external software
Projects
None yet
Development

No branches or pull requests

4 participants