Skip to content

Modify deprecation notice. #1616

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 2 commits into from
Jun 25, 2024
Merged

Modify deprecation notice. #1616

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dd6849e
Update deprecation link in headers.
jonsimantov Jun 25, 2024
be2b7a8
Update the text.
jonsimantov Jun 25, 2024
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
32 changes: 27 additions & 5 deletions gma/src/include/firebase/gma.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,15 +55,32 @@ template <typename ResultType>
class Future {
// Empty class (used for documentation only).
};

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is needed because the newly created GMA deprecation page throws a docs warning since it can't find firebase::App docs.

/// @brief Firebase App class. For more information, see the <a
/// href="https://firebase.google.com/docs/reference/cpp/class/firebase/app">Firebase
/// C++ SDK documentation</a>.
class App {
// Empty class (used for documentation only).
};

#endif // defined(DOXYGEN_ADMOB)

/// @brief API for Google Mobile Ads with Firebase.
///
/// The GMA API allows you to load and display mobile ads using the Google
/// Mobile Ads SDK. Each ad format has its own header file.
///
/// @deprecated The Google Mobile Ads C++ SDK is now deprecated. Please see
/// https://developers.google.com/admob/cpp/sdk for more information.
/// @deprecated **The Google Mobile Ads (GMA) C++ SDK is _deprecated_ as of June
/// 17, 2024 and should not be adopted in projects that don't already use it. It
/// will enter _End-of-Maintenance (EoM)_ on June 17, 2025. Note that versions
/// of the SDK released before the EoM date will continue to function, but no
/// further bug fixes or changes will be released after the EoM date.**
///
/// Instead of the Google Mobile Ads C++ SDK, consider using the
/// [iOS](/docs/admob/ios/quick-start) and
/// [Android](/docs/admob/android/quick-start) SDKs from AdMob. For support,
/// reach out to the [Google Mobile Ads SDK Technical
/// Forum](https://groups.google.com/g/google-admob-ads-sdk).
namespace gma {

/// Initializes Google Mobile Ads (GMA) via Firebase.
Expand All @@ -83,7 +100,10 @@ namespace gma {
/// Otherwise, the returned Future will have kFutureStatusInvalid.
///
/// @deprecated The Google Mobile Ads C++ SDK is now deprecated. Please see
/// https://developers.google.com/admob/cpp/sdk for more information.
/// the [SDK reference
/// documentation](
/// /admob/cpp/reference/namespace/firebase/gma)
/// for more information.
FIREBASE_DEPRECATED Future<AdapterInitializationStatus> Initialize(
const ::firebase::App& app, InitResult* init_result_out = nullptr);

Expand Down Expand Up @@ -115,7 +135,8 @@ FIREBASE_DEPRECATED Future<AdapterInitializationStatus> Initialize(
/// Otherwise, the returned Future will have kFutureStatusInvalid.
///
/// @deprecated The Google Mobile Ads C++ SDK is now deprecated. Please see
/// https://developers.google.com/admob/cpp/sdk for more information.
/// https://developers.google.com/admob/cpp/reference/namespace/firebase/gma
/// for more information.
FIREBASE_DEPRECATED Future<AdapterInitializationStatus> Initialize(
JNIEnv* jni_env, jobject activity, InitResult* init_result_out = nullptr);

Expand All @@ -137,7 +158,8 @@ FIREBASE_DEPRECATED Future<AdapterInitializationStatus> Initialize(
/// <code>kFutureStatusInvalid</code>.
///
/// @deprecated The Google Mobile Ads C++ SDK is now deprecated. Please see
/// https://developers.google.com/admob/cpp/sdk for more information.
/// https://developers.google.com/admob/cpp/reference/namespace/firebase/gma
/// for more information.
FIREBASE_DEPRECATED Future<AdapterInitializationStatus> Initialize(
InitResult* init_result_out = nullptr);
#endif // !defined(__ANDROID__) || defined(DOXYGEN)
Expand Down
3 changes: 2 additions & 1 deletion gma/src/include/firebase/gma/ad_view.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,8 @@ struct BoundingBox;
/// @endcode
///
/// @deprecated The Google Mobile Ads C++ SDK is now deprecated. Please see
/// https://developers.google.com/admob/cpp/sdk for more information.
/// https://developers.google.com/admob/cpp/reference/namespace/firebase/gma
/// for more information.
class AdView {
public:
/// The possible screen positions for a @ref AdView, configured via
Expand Down
3 changes: 2 additions & 1 deletion gma/src/include/firebase/gma/interstitial_ad.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,8 @@ class InterstitialAdInternal;
/// @endcode
///
/// @deprecated The Google Mobile Ads C++ SDK is now deprecated. Please see
/// https://developers.google.com/admob/cpp/sdk for more information.
/// https://developers.google.com/admob/cpp/reference/namespace/firebase/gma
/// for more information.
class InterstitialAd {
public:
/// Creates an uninitialized @ref InterstitialAd object.
Expand Down
3 changes: 2 additions & 1 deletion gma/src/include/firebase/gma/rewarded_ad.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,8 @@ class RewardedAdInternal;
/// @endcode
///
/// @deprecated The Google Mobile Ads C++ SDK is now deprecated. Please see
/// https://developers.google.com/admob/cpp/sdk for more information.
/// https://developers.google.com/admob/cpp/reference/namespace/firebase/gma
/// for more information.
class RewardedAd {
public:
/// Options for RewardedAd server-side verification callbacks. Set options on
Expand Down
Loading