AlexandreHiroyuki / AlexandreHiroyuki/DataTome

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

Open
#22 0 comments 0 reactions 0 assignees View on GitHub
documentation good first issue
Dominant language
C++
Stars
11
Forks
1
PR merge metrics
No merged PRs in 30d

Description

Comments have to be consistent with the [docs](https://github.com/AlexandreHiroyuki/DataTomeDocs)

Example:
```cpp
/**
* Do something.
* @param int data.
* @returns int data multiplied by 100.
*/
int do_something(int data) {
return data * 100;
}
```

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.