Skip to content

Commit 7ca8e40

Browse files
authored
Fix App and App Check headers for doxygen (#1339)
* Ignore the deleted constructors for doxygen * Fix app documentation * Update app.h * Update app.h
1 parent 974fb07 commit 7ca8e40

File tree

5 files changed

+10
-1
lines changed

5 files changed

+10
-1
lines changed

app/src/include/firebase/app.h

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -572,9 +572,10 @@ class App {
572572
static App* GetInstance(const char* name);
573573

574574
#if !defined(DOXYGEN)
575+
// Hidden from the public documentation for now
575576
/// Get all the apps, including the default one.
576577
static std::vector<App*> GetApps();
577-
#endif //! defined(DOXYGEN), to hide the api from public documentation.
578+
#endif // !defined(DOXYGEN)
578579

579580
#ifndef SWIG
580581
// <SWIG>

app_check/src/include/firebase/app_check/app_attest_provider.h

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,10 @@ class AppAttestProviderFactoryInternal;
2828
/// AppAttestProviders. This is the default implementation.
2929
class AppAttestProviderFactory : public AppCheckProviderFactory {
3030
public:
31+
#if !defined(DOXYGEN)
3132
AppAttestProviderFactory(const AppAttestProviderFactory&) = delete;
3233
AppAttestProviderFactory& operator=(const AppAttestProviderFactory&) = delete;
34+
#endif // !defined(DOXYGEN)
3335

3436
/// Gets an instance of this class for installation into a
3537
/// firebase::app_check::AppCheck instance.

app_check/src/include/firebase/app_check/debug_provider.h

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,11 @@ class DebugAppCheckProviderFactoryInternal;
3636
/// NOTE: Do not use the debug provider in applications used by real users.
3737
class DebugAppCheckProviderFactory : public AppCheckProviderFactory {
3838
public:
39+
#if !defined(DOXYGEN)
3940
DebugAppCheckProviderFactory(const DebugAppCheckProviderFactory&) = delete;
4041
DebugAppCheckProviderFactory& operator=(const DebugAppCheckProviderFactory&) =
4142
delete;
43+
#endif // !defined(DOXYGEN)
4244

4345
/// Gets an instance of this class for installation into a
4446
/// firebase::app_check::AppCheck instance.

app_check/src/include/firebase/app_check/device_check_provider.h

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,11 @@ class DeviceCheckProviderFactoryInternal;
2828
/// DeviceCheckProviders. This is the default implementation.
2929
class DeviceCheckProviderFactory : public AppCheckProviderFactory {
3030
public:
31+
#if !defined(DOXYGEN)
3132
DeviceCheckProviderFactory(const DeviceCheckProviderFactory&) = delete;
3233
DeviceCheckProviderFactory& operator=(const DeviceCheckProviderFactory&) =
3334
delete;
35+
#endif // !defined(DOXYGEN)
3436

3537
/// Gets an instance of this class for installation into a
3638
/// firebase::app_check::AppCheck instance.

app_check/src/include/firebase/app_check/play_integrity_provider.h

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,11 @@ class PlayIntegrityProviderFactoryInternal;
2828
/// PlayIntegrityProviders. This is the default implementation.
2929
class PlayIntegrityProviderFactory : public AppCheckProviderFactory {
3030
public:
31+
#if !defined(DOXYGEN)
3132
PlayIntegrityProviderFactory(const PlayIntegrityProviderFactory&) = delete;
3233
PlayIntegrityProviderFactory& operator=(const PlayIntegrityProviderFactory&) =
3334
delete;
35+
#endif // !defined(DOXYGEN)
3436

3537
/// Gets an instance of this class for installation into a
3638
/// firebase::app_check::AppCheck instance.

0 commit comments

Comments
 (0)