Skip to content

Fix App and App Check headers for doxygen #1339

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jun 2, 2023
Merged

Fix App and App Check headers for doxygen #1339

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b5aeb83
Ignore the deleted constructors for doxygen
a-maurice Jun 1, 2023
2104ca0
Fix app documentation
a-maurice Jun 2, 2023
1d330e4
Update app.h
a-maurice Jun 2, 2023
27fb369
Update app.h
a-maurice Jun 2, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion app/src/include/firebase/app.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -572,9 +572,10 @@ class App {
static App* GetInstance(const char* name);

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

#ifndef SWIG
// <SWIG>
Expand Down
2 changes: 2 additions & 0 deletions app_check/src/include/firebase/app_check/app_attest_provider.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 2 additions & 0 deletions app_check/src/include/firebase/app_check/debug_provider.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 2 additions & 0 deletions app_check/src/include/firebase/app_check/device_check_provider.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 2 additions & 0 deletions app_check/src/include/firebase/app_check/play_integrity_provider.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down