disable doxygen for private header API

awslabs · Oct 4, 2023 · 859a989 · 859a989
1 parent 4e63460
commit 859a989
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 0 deletions.
diff --git a/include/aws/crt/mqtt/private/Mqtt5ClientCore.h b/include/aws/crt/mqtt/private/Mqtt5ClientCore.h
@@ -1,3 +1,7 @@
+/*! \cond DOXYGEN_PRIVATE
+** Hide API from this file in doxygen. Set DOXYGEN_PRIVATE in doxygen
+** config to enable this file for doxygen.
+*/
 #pragma once
 /**
  * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
@@ -253,3 +257,4 @@ namespace Aws
         } // namespace Mqtt5
     }     // namespace Crt
 } // namespace Aws
+/*! \endcond */
diff --git a/include/aws/crt/mqtt/private/MqttConnectionCore.h b/include/aws/crt/mqtt/private/MqttConnectionCore.h
@@ -1,3 +1,7 @@
+/*! \cond DOXYGEN_PRIVATE
+** Hide API from this file in doxygen. Set DOXYGEN_PRIVATE in doxygen
+** config to enable this file for doxygen.
+*/
 #pragma once
 /**
  * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
@@ -388,3 +392,4 @@ namespace Aws
         } // namespace Mqtt
     }     // namespace Crt
 } // namespace Aws
+/*! \endcond */
diff --git a/source/mqtt/Mqtt5ClientCore.cpp b/source/mqtt/Mqtt5ClientCore.cpp
@@ -1,3 +1,7 @@
+/*! \cond DOXYGEN_PRIVATE
+** Hide API from this file in doxygen. Set DOXYGEN_PRIVATE in doxygen
+** config to enable this file for doxygen.
+*/
 /**
  * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
  * SPDX-License-Identifier: Apache-2.0.
@@ -651,3 +655,4 @@ namespace Aws
         } // namespace Mqtt5
     }     // namespace Crt
 } // namespace Aws
+/*! \endcond */
diff --git a/source/mqtt/MqttConnectionCore.cpp b/source/mqtt/MqttConnectionCore.cpp
@@ -1,3 +1,7 @@
+/*! \cond DOXYGEN_PRIVATE
+** Hide API from this file in doxygen. Set DOXYGEN_PRIVATE in doxygen
+** config to enable this file for doxygen.
+*/
 /**
  * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
  * SPDX-License-Identifier: Apache-2.0.
@@ -917,3 +921,4 @@ namespace Aws
         } // namespace Mqtt
     }     // namespace Crt
 } // namespace Aws
+/*! \endcond */