From f0fbff6dd48a73f445bae1a9e52cbab5c32f51a8 Mon Sep 17 00:00:00 2001 From: Dmitri Smirnov Date: Wed, 12 Oct 2022 18:07:18 -0700 Subject: [PATCH] Adjust docs to comply with Doxygen requirements (#13302) ### Description Fix up param names in docs ### Motivation and Context Make pipelines pass --- .../core/session/onnxruntime_cxx_api.h | 21 ++++++++++++------- 1 file changed, 14 insertions(+), 7 deletions(-) diff --git a/include/onnxruntime/core/session/onnxruntime_cxx_api.h b/include/onnxruntime/core/session/onnxruntime_cxx_api.h index 38836e6664..7c344f57db 100644 --- a/include/onnxruntime/core/session/onnxruntime_cxx_api.h +++ b/include/onnxruntime/core/session/onnxruntime_cxx_api.h @@ -104,7 +104,11 @@ const OrtApi* Global::api_ = OrtGetApiBase()->GetApi(ORT_API_VERSION); /// This returns a reference to the OrtApi interface in use inline const OrtApi& GetApi() { return *Global::api_; } -/// This is a C++ wrapper for OrtApi::GetAvailableProviders() and returns a vector of strings representing the available execution providers. +/// +/// This is a C++ wrapper for OrtApi::GetAvailableProviders() and +/// returns a vector of strings representing the available execution providers. +/// +/// vector of strings std::vector GetAvailableProviders(); /** \brief IEEE 754 half-precision floating point data type @@ -991,24 +995,27 @@ struct ValueImpl : ConstValueImpl { void* GetTensorMutableRawData(); /// - /// Obtain a reference to an element of data at the location specified + // Obtain a reference to an element of data at the location specified /// by the vector of dims. /// + /// + /// [in] expressed by a vecotr of dimensions offsets + /// template R& At(const std::vector& location); /// /// Set all strings at once in a string tensor /// - /// [in] s An array of strings. Each string in this array must be null terminated. - /// s_len Count of strings in s (Must match the size of \p value's tensor shape) + /// [in] An array of strings. Each string in this array must be null terminated. + /// [in] Count of strings in s (Must match the size of \p value's tensor shape) void FillStringTensor(const char* const* s, size_t s_len); /// - /// Set a single string in a string tensor + /// Set a single string in a string tensor /// - /// s A null terminated UTF-8 encoded string - /// index Index of the string in the tensor to set + /// [in] A null terminated UTF-8 encoded string + /// [in] Index of the string in the tensor to set void FillStringTensorElement(const char* s, size_t index); #if !defined(DISABLE_SPARSE_TENSORS)