From b5aeb833f7be522cbde4e346ec140d729a77c432 Mon Sep 17 00:00:00 2001 From: a-maurice Date: Thu, 1 Jun 2023 16:48:21 -0700 Subject: [PATCH 1/4] Ignore the deleted constructors for doxygen --- app_check/src/include/firebase/app_check/app_attest_provider.h | 2 ++ app_check/src/include/firebase/app_check/debug_provider.h | 2 ++ .../src/include/firebase/app_check/device_check_provider.h | 2 ++ .../src/include/firebase/app_check/play_integrity_provider.h | 2 ++ 4 files changed, 8 insertions(+) diff --git a/app_check/src/include/firebase/app_check/app_attest_provider.h b/app_check/src/include/firebase/app_check/app_attest_provider.h index 252112c14f..4f54d4bf80 100644 --- a/app_check/src/include/firebase/app_check/app_attest_provider.h +++ b/app_check/src/include/firebase/app_check/app_attest_provider.h @@ -28,8 +28,10 @@ class AppAttestProviderFactoryInternal; /// AppAttestProviders. This is the default implementation. class AppAttestProviderFactory : public AppCheckProviderFactory { public: +#if !defined(DOXYGEN) AppAttestProviderFactory(const AppAttestProviderFactory&) = delete; AppAttestProviderFactory& operator=(const AppAttestProviderFactory&) = delete; +#endif // !defined(DOXYGEN) /// Gets an instance of this class for installation into a /// firebase::app_check::AppCheck instance. diff --git a/app_check/src/include/firebase/app_check/debug_provider.h b/app_check/src/include/firebase/app_check/debug_provider.h index a4d9198aed..b36ea304dd 100644 --- a/app_check/src/include/firebase/app_check/debug_provider.h +++ b/app_check/src/include/firebase/app_check/debug_provider.h @@ -36,9 +36,11 @@ class DebugAppCheckProviderFactoryInternal; /// NOTE: Do not use the debug provider in applications used by real users. class DebugAppCheckProviderFactory : public AppCheckProviderFactory { public: +#if !defined(DOXYGEN) DebugAppCheckProviderFactory(const DebugAppCheckProviderFactory&) = delete; DebugAppCheckProviderFactory& operator=(const DebugAppCheckProviderFactory&) = delete; +#endif // !defined(DOXYGEN) /// Gets an instance of this class for installation into a /// firebase::app_check::AppCheck instance. diff --git a/app_check/src/include/firebase/app_check/device_check_provider.h b/app_check/src/include/firebase/app_check/device_check_provider.h index 89d6795bfc..521a97a484 100644 --- a/app_check/src/include/firebase/app_check/device_check_provider.h +++ b/app_check/src/include/firebase/app_check/device_check_provider.h @@ -28,9 +28,11 @@ class DeviceCheckProviderFactoryInternal; /// DeviceCheckProviders. This is the default implementation. class DeviceCheckProviderFactory : public AppCheckProviderFactory { public: +#if !defined(DOXYGEN) DeviceCheckProviderFactory(const DeviceCheckProviderFactory&) = delete; DeviceCheckProviderFactory& operator=(const DeviceCheckProviderFactory&) = delete; +#endif // !defined(DOXYGEN) /// Gets an instance of this class for installation into a /// firebase::app_check::AppCheck instance. diff --git a/app_check/src/include/firebase/app_check/play_integrity_provider.h b/app_check/src/include/firebase/app_check/play_integrity_provider.h index bf7be9ad53..cd509dd3eb 100644 --- a/app_check/src/include/firebase/app_check/play_integrity_provider.h +++ b/app_check/src/include/firebase/app_check/play_integrity_provider.h @@ -28,9 +28,11 @@ class PlayIntegrityProviderFactoryInternal; /// PlayIntegrityProviders. This is the default implementation. class PlayIntegrityProviderFactory : public AppCheckProviderFactory { public: +#if !defined(DOXYGEN) PlayIntegrityProviderFactory(const PlayIntegrityProviderFactory&) = delete; PlayIntegrityProviderFactory& operator=(const PlayIntegrityProviderFactory&) = delete; +#endif // !defined(DOXYGEN) /// Gets an instance of this class for installation into a /// firebase::app_check::AppCheck instance. From 2104ca03bf018f4d434374997feb621ca0db2e0d Mon Sep 17 00:00:00 2001 From: a-maurice Date: Thu, 1 Jun 2023 17:22:17 -0700 Subject: [PATCH 2/4] Fix app documentation --- app/src/include/firebase/app.h | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/app/src/include/firebase/app.h b/app/src/include/firebase/app.h index e43edb1de8..a867541b10 100644 --- a/app/src/include/firebase/app.h +++ b/app/src/include/firebase/app.h @@ -572,9 +572,10 @@ class App { static App* GetInstance(const char* name); #if !defined(DOXYGEN) + // Hidden from the public API for now /// Get all the apps, including the default one. static std::vector GetApps(); -#endif //! defined(DOXYGEN), to hide the api from public documentation. +#endif //! defined(DOXYGEN) #ifndef SWIG // From 1d330e4d59f51d852b4eba77246ff9e77699ce04 Mon Sep 17 00:00:00 2001 From: a-maurice Date: Thu, 1 Jun 2023 17:38:02 -0700 Subject: [PATCH 3/4] Update app.h --- app/src/include/firebase/app.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/app/src/include/firebase/app.h b/app/src/include/firebase/app.h index a867541b10..477d8d3ea1 100644 --- a/app/src/include/firebase/app.h +++ b/app/src/include/firebase/app.h @@ -575,7 +575,7 @@ class App { // Hidden from the public API for now /// Get all the apps, including the default one. static std::vector GetApps(); -#endif //! defined(DOXYGEN) +#endif // !defined(DOXYGEN) #ifndef SWIG // From 27fb369a1cf13895e5e2aaf57cd46f619b8fea5b Mon Sep 17 00:00:00 2001 From: a-maurice Date: Thu, 1 Jun 2023 17:40:08 -0700 Subject: [PATCH 4/4] Update app.h --- app/src/include/firebase/app.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/app/src/include/firebase/app.h b/app/src/include/firebase/app.h index 477d8d3ea1..f32f8bf33f 100644 --- a/app/src/include/firebase/app.h +++ b/app/src/include/firebase/app.h @@ -572,7 +572,7 @@ class App { static App* GetInstance(const char* name); #if !defined(DOXYGEN) - // Hidden from the public API for now + // Hidden from the public documentation for now /// Get all the apps, including the default one. static std::vector GetApps(); #endif // !defined(DOXYGEN)