From 1f849ec38435c3151fa358b5cf2073857a83e04d Mon Sep 17 00:00:00 2001 From: Victor Vazquez Date: Mon, 8 Feb 2021 17:13:30 -0800 Subject: [PATCH] fix docs (#1633) --- cmake-modules/AzureDoxygen.cmake | 3 +-- sdk/core/azure-core/inc/azure/core/context.hpp | 3 ++- sdk/core/azure-core/inc/azure/core/http/policy.hpp | 5 ++++- .../inc/azure/core/http/winhttp/win_http_client.hpp | 1 + .../azure-core/inc/azure/core/internal/json_serializable.hpp | 1 + sdk/core/azure-core/inc/azure/core/internal/strings.hpp | 1 + 6 files changed, 10 insertions(+), 4 deletions(-) diff --git a/cmake-modules/AzureDoxygen.cmake b/cmake-modules/AzureDoxygen.cmake index 6442ab43b..8504543ad 100644 --- a/cmake-modules/AzureDoxygen.cmake +++ b/cmake-modules/AzureDoxygen.cmake @@ -25,9 +25,8 @@ function(generate_documentation PROJECT_NAME PROJECT_VERSION) test *private*) # Skip documenting Details symbols (all from ::Details namespace) - set(DOXYGEN_EXCLUDE_SYMBOLS Details) + set(DOXYGEN_EXCLUDE_SYMBOLS Details Internal) set(DOXYGEN_IGNORE_PREFIX az_ AZ_) - set(DOXYGEN_) set(DOXYGEN_HTML_HEADER ${CMAKE_SOURCE_DIR}/eng/docs/api/assets/header.html) set(DOXYGEN_HTML_FOOTER ${CMAKE_SOURCE_DIR}/eng/docs/api/assets/footer.html) set(DOXYGEN_HTML_STYLESHEET ${CMAKE_SOURCE_DIR}/eng/docs/api/assets/style.css) diff --git a/sdk/core/azure-core/inc/azure/core/context.hpp b/sdk/core/azure-core/inc/azure/core/context.hpp index 77c409965..6c946f9dc 100644 --- a/sdk/core/azure-core/inc/azure/core/context.hpp +++ b/sdk/core/azure-core/inc/azure/core/context.hpp @@ -19,7 +19,8 @@ namespace Azure { namespace Core { /** - * @ A base abstract class for the `std::unique_ptr` value representation in #ContextValue. + * @brief A base abstract class for the `std::unique_ptr` value representation in #ContextValue. + * */ struct ValueBase { diff --git a/sdk/core/azure-core/inc/azure/core/http/policy.hpp b/sdk/core/azure-core/inc/azure/core/http/policy.hpp index 6691d35b7..0e8065c16 100644 --- a/sdk/core/azure-core/inc/azure/core/http/policy.hpp +++ b/sdk/core/azure-core/inc/azure/core/http/policy.hpp @@ -73,7 +73,10 @@ namespace Azure { namespace Core { namespace Http { HttpPolicy& operator=(const HttpPolicy& other) = default; }; - // Represents the next HTTP policy in the stack sequence of policies. + /** + * @brief Represents the next HTTP policy in the stack sequence of policies. + * + */ class NextHttpPolicy { const std::size_t m_index; const std::vector>& m_policies; diff --git a/sdk/core/azure-core/inc/azure/core/http/winhttp/win_http_client.hpp b/sdk/core/azure-core/inc/azure/core/http/winhttp/win_http_client.hpp index 1b4296215..60edf5b3d 100644 --- a/sdk/core/azure-core/inc/azure/core/http/winhttp/win_http_client.hpp +++ b/sdk/core/azure-core/inc/azure/core/http/winhttp/win_http_client.hpp @@ -2,6 +2,7 @@ // SPDX-License-Identifier: MIT /** + * @file * @brief #HttpTransport implementation via WinHttp. */ diff --git a/sdk/core/azure-core/inc/azure/core/internal/json_serializable.hpp b/sdk/core/azure-core/inc/azure/core/internal/json_serializable.hpp index bdb90440c..b8a0e8b5b 100644 --- a/sdk/core/azure-core/inc/azure/core/internal/json_serializable.hpp +++ b/sdk/core/azure-core/inc/azure/core/internal/json_serializable.hpp @@ -2,6 +2,7 @@ // SPDX-License-Identifier: MIT /** + * @file * @brief Internal interface for serializable classes. * */ diff --git a/sdk/core/azure-core/inc/azure/core/internal/strings.hpp b/sdk/core/azure-core/inc/azure/core/internal/strings.hpp index 0e121adcb..85e697b90 100644 --- a/sdk/core/azure-core/inc/azure/core/internal/strings.hpp +++ b/sdk/core/azure-core/inc/azure/core/internal/strings.hpp @@ -2,6 +2,7 @@ // SPDX-License-Identifier: MIT /** + * @file * @brief Internal utility functions for strings. * */