Improve C++ documentation

[kingcrimsontianyu]

Doxygen reports a list of warnings for undocumented C++ entities. We should strive to document as much as possible in Doxygen, including public API and internals.

/home/coder/kvikio/cpp/include/kvikio/shim/cufile_h_wrapper.hpp:55: warning: Compound CUfileDescr_t is not documented.
/home/coder/kvikio/cpp/include/kvikio/shim/cufile_h_wrapper.hpp:57: warning: Compound CUfileDescr_t::handle_t is not documented.
/home/coder/kvikio/cpp/include/kvikio/shim/cufile_h_wrapper.hpp:43: warning: Compound CUfileError_t is not documented.
/home/coder/kvikio/cpp/include/kvikio/shim/cufile_h_wrapper.hpp:95: warning: Compound CUfileIOEvents is not documented.
/home/coder/kvikio/cpp/include/kvikio/batch.hpp:120: warning: Compound kvikio::BatchHandle is not documented.
/home/coder/kvikio/cpp/include/kvikio/cufile/driver.hpp:84: warning: Compound kvikio::DriverInitializer is not documented.
/home/coder/kvikio/cpp/include/kvikio/cufile/driver.hpp:89: warning: Compound kvikio::DriverProperties is not documented.
Generating docs for file defaults.hpp...
/home/coder/kvikio/cpp/include/kvikio/defaults.hpp:63: warning: Member getenv_or(std::string_view env_var_name, T default_val) (function) of  kvikio is not documented.
/home/coder/kvikio/cpp/include/kvikio/defaults.hpp:79: warning: Member getenv_or(std::string_view env_var_name, bool default_val) (function) of  kvikio is not documented.
/home/coder/kvikio/cpp/include/kvikio/defaults.hpp:82: warning: Member getenv_or(std::string_view env_var_name, CompatMode default_val) (function) of  kvikio is not documented.
Generating docs for compound CUfileDescr_t...
/home/coder/kvikio/cpp/include/kvikio/shim/cufile_h_wrapper.hpp:45: warning: Member type (variable) of struct CUfileDescr_t is not documented.
/home/coder/kvikio/cpp/include/kvikio/shim/cufile_h_wrapper.hpp:59: warning: Member handle (variable) of struct CUfileDescr_t is not documented.
Generating docs for nested compound CUfileDescr_t::handle_t...
/home/coder/kvikio/cpp/include/kvikio/shim/cufile_h_wrapper.hpp:58: warning: Member fd (variable) of struct CUfileDescr_t::handle_t is not documented.
Generating docs for compound CUfileError_t...
/home/coder/kvikio/cpp/include/kvikio/shim/cufile_h_wrapper.hpp:44: warning: Member err (variable) of struct CUfileError_t is not documented.
/home/coder/kvikio/cpp/include/kvikio/shim/cufile_h_wrapper.hpp:45: warning: Member cu_err (variable) of struct CUfileError_t is not documented.
Generating docs for compound CUfileIOEvents...
/home/coder/kvikio/cpp/include/kvikio/shim/cufile_h_wrapper.hpp:96: warning: Member cookie (variable) of struct CUfileIOEvents is not documented.
/home/coder/kvikio/cpp/include/kvikio/shim/cufile_h_wrapper.hpp:97: warning: Member status (variable) of struct CUfileIOEvents is not documented.
/home/coder/kvikio/cpp/include/kvikio/shim/cufile_h_wrapper.hpp:98: warning: Member ret (variable) of struct CUfileIOEvents is not documented.
Generating namespace index...
Generating docs for compound kvikio::BatchOp...
/home/coder/kvikio/cpp/include/kvikio/batch.hpp:34: warning: Member file_handle (variable) of struct kvikio::BatchOp is not documented.
/home/coder/kvikio/cpp/include/kvikio/batch.hpp:36: warning: Member devPtr_base (variable) of struct kvikio::BatchOp is not documented.
/home/coder/kvikio/cpp/include/kvikio/batch.hpp:38: warning: Member file_offset (variable) of struct kvikio::BatchOp is not documented.
/home/coder/kvikio/cpp/include/kvikio/batch.hpp:40: warning: Member devPtr_offset (variable) of struct kvikio::BatchOp is not documented.
/home/coder/kvikio/cpp/include/kvikio/batch.hpp:42: warning: Member size (variable) of struct kvikio::BatchOp is not documented.
/home/coder/kvikio/cpp/include/kvikio/batch.hpp:44: warning: Member opcode (variable) of struct kvikio::BatchOp is not documented.
Generating docs for compound kvikio::BatchHandle...
/home/coder/kvikio/cpp/include/kvikio/batch.hpp:124: warning: Member BatchHandle(int max_num_events) (function) of class kvikio::BatchHandle is not documented.
/home/coder/kvikio/cpp/include/kvikio/batch.hpp:126: warning: Member closed() const noexcept (function) of class kvikio::BatchHandle is not documented.
/home/coder/kvikio/cpp/include/kvikio/batch.hpp:128: warning: Member close() noexcept (function) of class kvikio::BatchHandle is not documented.
/home/coder/kvikio/cpp/include/kvikio/batch.hpp:130: warning: Member submit(std::vector< BatchOp > const &operations) (function) of class kvikio::BatchHandle is not documented.
/home/coder/kvikio/cpp/include/kvikio/batch.hpp:132: warning: Member status(unsigned min_nr, unsigned max_nr, struct timespec *timeout=nullptr) (function) of class kvikio::BatchHandle is not documented.
/home/coder/kvikio/cpp/include/kvikio/batch.hpp:136: warning: Member cancel() (function) of class kvikio::BatchHandle is not documented.
Generating docs for compound kvikio::AllocRetain...
/home/coder/kvikio/cpp/include/kvikio/bounce_buffer.hpp:86: warning: Member get() (function) of class kvikio::AllocRetain is not documented.
/home/coder/kvikio/cpp/include/kvikio/bounce_buffer.hpp:88: warning: Member put(void *alloc, std::size_t size) (function) of class kvikio::AllocRetain is not documented.
/home/coder/kvikio/cpp/include/kvikio/bounce_buffer.hpp:97: warning: Member instance() (function) of class kvikio::AllocRetain is not documented.
Generating docs for nested compound kvikio::AllocRetain::Alloc...
/home/coder/kvikio/cpp/include/kvikio/bounce_buffer.hpp:49: warning: Member Alloc(AllocRetain *manager, void *alloc, std::size_t size) (function) of class kvikio::AllocRetain::Alloc is not documented.
/home/coder/kvikio/cpp/include/kvikio/bounce_buffer.hpp:55: warning: Member get() noexcept (function) of class kvikio::AllocRetain::Alloc is not documented.
/home/coder/kvikio/cpp/include/kvikio/bounce_buffer.hpp:56: warning: Member get(std::ptrdiff_t offset) noexcept (function) of class kvikio::AllocRetain::Alloc is not documented.
/home/coder/kvikio/cpp/include/kvikio/bounce_buffer.hpp:57: warning: Member size() noexcept (function) of class kvikio::AllocRetain::Alloc is not documented.
Generating docs for compound kvikio::DriverInitializer...
Generating docs for compound kvikio::DriverProperties...
/home/coder/kvikio/cpp/include/kvikio/cufile/driver.hpp:121: warning: Member get_max_batch_io_size() (function) of struct kvikio::DriverProperties is not documented.
/home/coder/kvikio/cpp/include/kvikio/cufile/driver.hpp:93: warning: Member is_gds_available() (function) of struct kvikio::DriverProperties is not documented.
/home/coder/kvikio/cpp/include/kvikio/cufile/driver.hpp:95: warning: Member get_nvfs_major_version() (function) of struct kvikio::DriverProperties is not documented.
/home/coder/kvikio/cpp/include/kvikio/cufile/driver.hpp:97: warning: Member get_nvfs_minor_version() (function) of struct kvikio::DriverProperties is not documented.
/home/coder/kvikio/cpp/include/kvikio/cufile/driver.hpp:99: warning: Member get_nvfs_allow_compat_mode() (function) of struct kvikio::DriverProperties is not documented.
/home/coder/kvikio/cpp/include/kvikio/cufile/driver.hpp:101: warning: Member get_nvfs_poll_mode() (function) of struct kvikio::DriverProperties is not documented.
/home/coder/kvikio/cpp/include/kvikio/cufile/driver.hpp:103: warning: Member get_nvfs_poll_thresh_size() (function) of struct kvikio::DriverProperties is not documented.
/home/coder/kvikio/cpp/include/kvikio/cufile/driver.hpp:105: warning: Member set_nvfs_poll_mode(bool enable) (function) of struct kvikio::DriverProperties is not documented.
/home/coder/kvikio/cpp/include/kvikio/cufile/driver.hpp:107: warning: Member set_nvfs_poll_thresh_size(std::size_t size_in_kb) (function) of struct kvikio::DriverProperties is not documented.
/home/coder/kvikio/cpp/include/kvikio/cufile/driver.hpp:109: warning: Member get_nvfs_statusflags() (function) of struct kvikio::DriverProperties is not documented.
/home/coder/kvikio/cpp/include/kvikio/cufile/driver.hpp:111: warning: Member get_max_device_cache_size() (function) of struct kvikio::DriverProperties is not documented.
/home/coder/kvikio/cpp/include/kvikio/cufile/driver.hpp:113: warning: Member set_max_device_cache_size(std::size_t size_in_kb) (function) of struct kvikio::DriverProperties is not documented.
/home/coder/kvikio/cpp/include/kvikio/cufile/driver.hpp:115: warning: Member get_per_buffer_cache_size() (function) of struct kvikio::DriverProperties is not documented.
/home/coder/kvikio/cpp/include/kvikio/cufile/driver.hpp:117: warning: Member get_max_pinned_memory_size() (function) of struct kvikio::DriverProperties is not documented.
/home/coder/kvikio/cpp/include/kvikio/cufile/driver.hpp:119: warning: Member set_max_pinned_memory_size(std::size_t size_in_kb) (function) of struct kvikio::DriverProperties is not documented.
Generating docs for compound kvikio::defaults...
/home/coder/kvikio/cpp/include/kvikio/defaults.hpp:142: warning: parameters of member kvikio::defaults::infer_compat_mode_if_auto are not (all) documented
/home/coder/kvikio/cpp/include/kvikio/defaults.hpp:142: warning: return type of member kvikio::defaults::infer_compat_mode_if_auto is not documented
Generating docs for compound kvikio::CUfileException...
Generating docs for compound kvikio::FileHandle...
/home/coder/kvikio/cpp/include/kvikio/file_handle.hpp:95: warning: Member FileHandle(FileHandle &&o) noexcept (function) of class kvikio::FileHandle is not documented.
/home/coder/kvikio/cpp/include/kvikio/file_handle.hpp:96: warning: Member operator=(FileHandle &&o) noexcept (function) of class kvikio::FileHandle is not documented.
/home/coder/kvikio/cpp/include/kvikio/file_handle.hpp:66: warning: Member m644 (variable) of class kvikio::FileHandle is not documented.
Generating docs for compound kvikio::RemoteEndpoint...
Generating docs for compound kvikio::HttpEndpoint...
Generating docs for compound kvikio::S3Endpoint...
/home/coder/kvikio/cpp/include/kvikio/remote_handle.hpp:149: warning: explicit link request to 'url_from_bucket_and_object()' could not be resolved
/home/coder/kvikio/cpp/include/kvikio/remote_handle.hpp:129: warning: return type of member kvikio::S3Endpoint::url_from_bucket_and_object is not documented
Generating docs for compound kvikio::RemoteHandle...
/home/coder/kvikio/cpp/include/kvikio/remote_handle.hpp:217: warning: Member RemoteHandle(RemoteHandle &&o)=default (function) of class kvikio::RemoteHandle is not documented.
/home/coder/kvikio/cpp/include/kvikio/remote_handle.hpp:218: warning: Member operator=(RemoteHandle &&o)=default (function) of class kvikio::RemoteHandle is not documented.
Generating docs for compound kvikio::cudaAPI...
/home/coder/kvikio/cpp/include/kvikio/shim/cuda.hpp:59: warning: Member instance() (function) of class kvikio::cudaAPI is not documented.
/home/coder/kvikio/cpp/include/kvikio/shim/cuda.hpp:32: warning: Member Init (variable) of class kvikio::cudaAPI is not documented.
/home/coder/kvikio/cpp/include/kvikio/shim/cuda.hpp:33: warning: Member MemHostAlloc (variable) of class kvikio::cudaAPI is not documented.
/home/coder/kvikio/cpp/include/kvikio/shim/cuda.hpp:34: warning: Member MemFreeHost (variable) of class kvikio::cudaAPI is not documented.
/home/coder/kvikio/cpp/include/kvikio/shim/cuda.hpp:35: warning: Member MemcpyHtoDAsync (variable) of class kvikio::cudaAPI is not documented.
/home/coder/kvikio/cpp/include/kvikio/shim/cuda.hpp:36: warning: Member MemcpyDtoHAsync (variable) of class kvikio::cudaAPI is not documented.
/home/coder/kvikio/cpp/include/kvikio/shim/cuda.hpp:37: warning: Member PointerGetAttribute (variable) of class kvikio::cudaAPI is not documented.
/home/coder/kvikio/cpp/include/kvikio/shim/cuda.hpp:38: warning: Member PointerGetAttributes (variable) of class kvikio::cudaAPI is not documented.
/home/coder/kvikio/cpp/include/kvikio/shim/cuda.hpp:39: warning: Member CtxPushCurrent (variable) of class kvikio::cudaAPI is not documented.
/home/coder/kvikio/cpp/include/kvikio/shim/cuda.hpp:40: warning: Member CtxPopCurrent (variable) of class kvikio::cudaAPI is not documented.
/home/coder/kvikio/cpp/include/kvikio/shim/cuda.hpp:41: warning: Member CtxGetCurrent (variable) of class kvikio::cudaAPI is not documented.
/home/coder/kvikio/cpp/include/kvikio/shim/cuda.hpp:42: warning: Member MemGetAddressRange (variable) of class kvikio::cudaAPI is not documented.
/home/coder/kvikio/cpp/include/kvikio/shim/cuda.hpp:43: warning: Member GetErrorName (variable) of class kvikio::cudaAPI is not documented.
/home/coder/kvikio/cpp/include/kvikio/shim/cuda.hpp:44: warning: Member GetErrorString (variable) of class kvikio::cudaAPI is not documented.
/home/coder/kvikio/cpp/include/kvikio/shim/cuda.hpp:45: warning: Member DeviceGet (variable) of class kvikio::cudaAPI is not documented.
/home/coder/kvikio/cpp/include/kvikio/shim/cuda.hpp:46: warning: Member DevicePrimaryCtxRetain (variable) of class kvikio::cudaAPI is not documented.
/home/coder/kvikio/cpp/include/kvikio/shim/cuda.hpp:47: warning: Member DevicePrimaryCtxRelease (variable) of class kvikio::cudaAPI is not documented.
/home/coder/kvikio/cpp/include/kvikio/shim/cuda.hpp:48: warning: Member StreamSynchronize (variable) of class kvikio::cudaAPI is not documented.
/home/coder/kvikio/cpp/include/kvikio/shim/cuda.hpp:49: warning: Member StreamCreate (variable) of class kvikio::cudaAPI is not documented.
/home/coder/kvikio/cpp/include/kvikio/shim/cuda.hpp:50: warning: Member StreamDestroy (variable) of class kvikio::cudaAPI is not documented.
Generating docs for compound kvikio::cuFileAPI...
/home/coder/kvikio/cpp/include/kvikio/shim/cufile.hpp:81: warning: Member instance() (function) of class kvikio::cuFileAPI is not documented.
/home/coder/kvikio/cpp/include/kvikio/shim/cufile.hpp:32: warning: Member HandleRegister (variable) of class kvikio::cuFileAPI is not documented.
/home/coder/kvikio/cpp/include/kvikio/shim/cufile.hpp:33: warning: Member HandleDeregister (variable) of class kvikio::cuFileAPI is not documented.
/home/coder/kvikio/cpp/include/kvikio/shim/cufile.hpp:34: warning: Member Read (variable) of class kvikio::cuFileAPI is not documented.
/home/coder/kvikio/cpp/include/kvikio/shim/cufile.hpp:35: warning: Member Write (variable) of class kvikio::cuFileAPI is not documented.
/home/coder/kvikio/cpp/include/kvikio/shim/cufile.hpp:36: warning: Member BufRegister (variable) of class kvikio::cuFileAPI is not documented.
/home/coder/kvikio/cpp/include/kvikio/shim/cufile.hpp:37: warning: Member BufDeregister (variable) of class kvikio::cuFileAPI is not documented.
/home/coder/kvikio/cpp/include/kvikio/shim/cufile.hpp:38: warning: Member DriverGetProperties (variable) of class kvikio::cuFileAPI is not documented.
/home/coder/kvikio/cpp/include/kvikio/shim/cufile.hpp:39: warning: Member DriverSetPollMode (variable) of class kvikio::cuFileAPI is not documented.
/home/coder/kvikio/cpp/include/kvikio/shim/cufile.hpp:40: warning: Member DriverSetMaxCacheSize (variable) of class kvikio::cuFileAPI is not documented.
/home/coder/kvikio/cpp/include/kvikio/shim/cufile.hpp:41: warning: Member DriverSetMaxPinnedMemSize (variable) of class kvikio::cuFileAPI is not documented.
/home/coder/kvikio/cpp/include/kvikio/shim/cufile.hpp:42: warning: Member BatchIOSetUp (variable) of class kvikio::cuFileAPI is not documented.
/home/coder/kvikio/cpp/include/kvikio/shim/cufile.hpp:43: warning: Member BatchIOSubmit (variable) of class kvikio::cuFileAPI is not documented.
/home/coder/kvikio/cpp/include/kvikio/shim/cufile.hpp:44: warning: Member BatchIOGetStatus (variable) of class kvikio::cuFileAPI is not documented.
/home/coder/kvikio/cpp/include/kvikio/shim/cufile.hpp:45: warning: Member BatchIOCancel (variable) of class kvikio::cuFileAPI is not documented.
/home/coder/kvikio/cpp/include/kvikio/shim/cufile.hpp:46: warning: Member BatchIODestroy (variable) of class kvikio::cuFileAPI is not documented.
/home/coder/kvikio/cpp/include/kvikio/shim/cufile.hpp:47: warning: Member ReadAsync (variable) of class kvikio::cuFileAPI is not documented.
/home/coder/kvikio/cpp/include/kvikio/shim/cufile.hpp:48: warning: Member WriteAsync (variable) of class kvikio::cuFileAPI is not documented.
/home/coder/kvikio/cpp/include/kvikio/shim/cufile.hpp:49: warning: Member StreamRegister (variable) of class kvikio::cuFileAPI is not documented.
/home/coder/kvikio/cpp/include/kvikio/shim/cufile.hpp:50: warning: Member StreamDeregister (variable) of class kvikio::cuFileAPI is not documented.
/home/coder/kvikio/cpp/include/kvikio/shim/cufile.hpp:61: warning: Member version (variable) of class kvikio::cuFileAPI is not documented.
Generating docs for compound kvikio::LibCurl...
/home/coder/kvikio/cpp/include/kvikio/shim/libcurl.hpp:54: warning: Member UniqueHandlePtr (typedef) of class kvikio::LibCurl is not documented.
/home/coder/kvikio/cpp/include/kvikio/shim/libcurl.hpp:70: warning: return type of member kvikio::LibCurl::get_free_handle is not documented
/home/coder/kvikio/cpp/include/kvikio/shim/libcurl.hpp:75: warning: return type of member kvikio::LibCurl::get_handle is not documented
/home/coder/kvikio/cpp/include/kvikio/shim/libcurl.hpp:80: warning: parameters of member kvikio::LibCurl::retain_handle are not (all) documented
/home/coder/kvikio/cpp/include/kvikio/shim/libcurl.hpp:65: warning: Member instance() (function) of class kvikio::LibCurl is not documented.
Generating docs for compound kvikio::CurlHandle...
/home/coder/kvikio/cpp/include/kvikio/shim/libcurl.hpp:120: warning: return type of member kvikio::CurlHandle::handle is not documented
/home/coder/kvikio/cpp/include/kvikio/shim/libcurl.hpp:158: warning: The following parameter of kvikio::CurlHandle::getinfo(CURLINFO info, OUTPUT *output) is not documented:
  parameter 'info'
/home/coder/kvikio/cpp/include/kvikio/shim/libcurl.hpp:131: warning: The following parameter of kvikio::CurlHandle::setopt(CURLoption option, VAL value) is not documented:
  parameter 'value'
Generating docs for compound kvikio::StreamFuture...
/home/coder/kvikio/cpp/include/kvikio/stream.hpp:63: warning: Member StreamFuture(void *devPtr_base, std::size_t size, off_t file_offset, off_t devPtr_offset, CUstream stream) (function) of class kvikio::StreamFuture is not documented.
/home/coder/kvikio/cpp/include/kvikio/stream.hpp:71: warning: Member StreamFuture(StreamFuture &&o) noexcept (function) of class kvikio::StreamFuture is not documented.
/home/coder/kvikio/cpp/include/kvikio/stream.hpp:72: warning: Member operator=(StreamFuture &&o) noexcept (function) of class kvikio::StreamFuture is not documented.
Generating docs for compound kvikio::PushAndPopContext...
/home/coder/kvikio/cpp/include/kvikio/utils.hpp:141: warning: Member PushAndPopContext(CUcontext ctx) (function) of class kvikio::PushAndPopContext is not documented.
Generating docs for compound kvikio::detail::StreamsByThread...
/home/coder/kvikio/cpp/include/kvikio/posix_io.hpp:68: warning: Member get(CUcontext ctx, std::thread::id thd_id) (function) of class kvikio::detail::StreamsByThread is not documented.
/home/coder/kvikio/cpp/include/kvikio/posix_io.hpp:70: warning: Member get() (function) of class kvikio::detail::StreamsByThread is not documented.