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

Add Docs like comments on top of methods for nice IDE tooltips #22

Open
AlexandreHiroyuki opened this issue Dec 6, 2024 · 0 comments
Open
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@AlexandreHiroyuki
Copy link
Owner

Comments have to be consistent with the docs

Example:

/**
* Do something.
* @param int data.
* @returns int data multiplied by 100.
*/
int do_something(int data) {
  return data * 100;
}
@AlexandreHiroyuki AlexandreHiroyuki added documentation Improvements or additions to documentation good first issue Good for newcomers labels Dec 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant