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

Merge overloads when \overload is the only comment #925

Open
cjdb opened this issue May 26, 2023 · 1 comment
Open

Merge overloads when \overload is the only comment #925

cjdb opened this issue May 26, 2023 · 1 comment

Comments

@cjdb
Copy link

cjdb commented May 26, 2023

The current /// \overload adds some text to say that a function is an overload of something else, but it's possible to do this in raw reStructured text:

.. cpp:function::
  void f(int x);
  void f(double x);

This groups the two functions together, and puts prose text underneath both of them. I think documentation would be more readable if

/// some docs
void f(int x);

/// \overload
void f(double x);

were turned into the above rST instead of the following:

.. cpp:function:: void f(int x)

  some docs

.. cpp:function:: void f(double x)

  This is an overload...
@LecrisUT
Copy link

I would go slightly different. Merge them if there is no body. That would allow us to still specify \param and other such directives

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

No branches or pull requests

2 participants