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

Overload pages shows the description and documentation for the first overload #757

Open
anarthal opened this issue Dec 4, 2024 · 1 comment
Assignees

Comments

@anarthal
Copy link

anarthal commented Dec 4, 2024

https://www.boost.org/doc/libs/master/doc/antora/url/reference/boost/urls/url/2constructor.html

I think this is confusing.

@alandefreitas alandefreitas moved this to Accepted in MrDocs Dec 23, 2024
@alandefreitas alandefreitas self-assigned this Dec 23, 2024
@alandefreitas alandefreitas moved this from Accepted to In progress in MrDocs Dec 23, 2024
@alandefreitas
Copy link
Collaborator

We got that pattern from Boost.JSON, where the documentation comes from the first member. It works most of the time for member functions. But it's terrible for things like operator<<.

We can start by removing the description and only showing a union of the parameters, which is less controversial. Later, we could reintroduce a better way to inherit details about the overload set from the functions.

A number of heuristics could be used here:

  • Don't inherit details from free functions
  • Inherit details when only one overload is documented
  • ...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

No branches or pull requests

2 participants