jrhemstad / nvtx_wrappers

This repository is deprecated and the code has moved to the official NVIDIA NVTX github repository: https://github.com/NVIDIA/NVTX
Apache License 2.0
2 stars 0 forks source link

Review of complete draft of NVTX++ #1

Closed jrhemstad closed 4 years ago

jrhemstad commented 4 years ago

First version of NVTX C++ wrappers is complete and ready for review.

CUPTI based testing is far from complete and will be future work.

I tried to make sure everything was well documented. I'm hoping for reviews/suggestions on both documentation and the code itself.

See rendered documentation here: https://jrhemstad.github.io/nvtx_wrappers/html/index.html

Note: I opened this PR against an empty branch purely to make it easier to review. All of the code here is already in master.

jrhemstad commented 4 years ago

Looks great. I reviewed the overview documentation but not the detailed class documentation (by the time I got to it I was fatigued). In general there's a lot of docs for a very small library. People will want a quick start, most will not read the docs, since it's a tool they won't want to spend much time on.

I've never heard someone complain about a library having too much documentation before. :)

A quickstart is a good idea though.