Skip to content

Commit 1e5ebac

Browse files
Nicholas Ventimigliacopybara-github
authored andcommitted
Updated code comment strings.
PiperOrigin-RevId: 888233096
1 parent a08d58c commit 1e5ebac

17 files changed

+122
-31
lines changed

source/plugin/Assets/GoogleMobileAds/Api/AdError.cs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -54,18 +54,18 @@ public string GetDomain()
5454

5555
/// <summary>
5656
/// Returns the error message.
57-
/// <seealso href="https://support.google.com/admob/answer/9905175"/>
57+
/// <a href="https://support.google.com/admob/answer/9905175">https://support.google.com/admob/answer/9905175</a>
5858
/// for explanations of common errors.
59-
/// <summary>
59+
/// </summary>
6060
/// <returns>Ad Error Message. </returns>
6161
public string GetMessage()
6262
{
6363
return _client.GetMessage();
6464
}
6565

66-
///<summary>
67-
/// Returns the cause of this error or <c>null</c> if the cause is nonexistent or unknown.
6866
/// <summary>
67+
/// Returns the cause of this error or <c>null</c> if the cause is nonexistent or unknown.
68+
/// </summary>
6969
/// <returns>Returns the cause of this error.</returns>
7070
public AdError GetCause()
7171
{

source/plugin/Assets/GoogleMobileAds/Api/AdInspectorError.cs

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,34 +18,44 @@ namespace GoogleMobileAds.Api {
1818

1919
/// <summary>
2020
/// Error information about why the ad inspector failed.
21-
/// <summary>
21+
/// </summary>
2222
public class AdInspectorError : AdError {
2323

2424
/// <summary>
2525
/// Error information about why the ad inspector failed.
26-
/// <summary>
26+
/// </summary>
2727
public enum AdInspectorErrorCode {
2828
/// <summary>
2929
/// Ad inspector had an internal error.
30-
/// <summary>
30+
/// </summary>
3131
ERROR_CODE_INTERNAL_ERROR = 0,
3232
/// <summary>
3333
/// Ad inspector failed to load.
34-
/// <summary>
34+
/// </summary>
3535
ERROR_CODE_FAILED_TO_LOAD = 1,
3636
/// <summary>
3737
/// Ad inspector cannot be opened because the device is not in test mode.
3838
/// information.
39-
/// <summary>
39+
/// </summary>
4040
ERROR_CODE_NOT_IN_TEST_MODE = 2,
4141
/// <summary>
4242
/// Ad inspector cannot be opened because it is already open.
43-
/// <summary>
43+
/// </summary>
4444
ERROR_CODE_ALREADY_OPEN = 3
4545
}
4646

47+
/// <summary>
48+
/// Creates an <see cref="AdInspectorError"/>.
49+
/// </summary>
50+
/// <param name="client">
51+
/// A platform level <see cref="IAdInspectorErrorClient"/> implementation.
52+
/// </param>
4753
public AdInspectorError(IAdInspectorErrorClient client) : base(client) {}
4854

55+
/// <summary>
56+
/// Returns the error code.
57+
/// </summary>
58+
/// <returns>The error code.</returns>
4959
public new AdInspectorErrorCode GetCode() {
5060
return (AdInspectorErrorCode)base.GetCode();
5161
}

source/plugin/Assets/GoogleMobileAds/Api/AdapterResponseInfo.cs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,12 @@ public class AdapterResponseInfo
2424
{
2525
private IAdapterResponseInfoClient _client;
2626

27+
/// <summary>
28+
/// Creates an <see cref="AdapterResponseInfo"/>.
29+
/// </summary>
30+
/// <param name="client">
31+
/// A platform level <see cref="IAdapterResponseInfoClient"/> implementation.
32+
/// </param>
2733
public AdapterResponseInfo(IAdapterResponseInfoClient client)
2834
{
2935
_client = client;

source/plugin/Assets/GoogleMobileAds/Api/Core/AdRequest.cs

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ public class AdRequest
3535

3636
/// <summary>
3737
/// Test device ID used to load test ads.
38-
/// <seealso href="https://developers.google.com/admob/unity/test-ads"/>.
38+
/// <a href="https://developers.google.com/admob/unity/test-ads">https://developers.google.com/admob/unity/test-ads</a>.
3939
/// </summary>
4040
public const string TestDeviceSimulator = "SIMULATOR";
4141

@@ -52,6 +52,10 @@ static AdRequest()
5252

5353
public AdRequest() {}
5454

55+
/// <summary>
56+
/// Creates an <see cref="AdRequest"/> from a given <see cref="AdRequest"/>.
57+
/// </summary>
58+
/// <param name="request">The <see cref="AdRequest"/> parameter to copy.</param>
5559
public AdRequest(AdRequest request)
5660
{
5761
Keywords = request.Keywords;

source/plugin/Assets/GoogleMobileAds/Api/Core/AdSize.cs

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,9 @@ public enum Type
8181
[System.Obsolete("Deprecated. Use AnchoredAdaptive.")]
8282
public static readonly AdSize SmartBanner = new AdSize(0, 0, Type.SmartBanner);
8383

84+
/// <summary>
85+
/// The full width banner size.
86+
/// </summary>
8487
public static readonly int FullWidth = -1;
8588

8689
/// <summary>
@@ -108,16 +111,31 @@ private static AdSize CreateAnchoredAdaptiveAdSize(int width, Orientation orient
108111
return adSize;
109112
}
110113

114+
/// <summary>
115+
/// Gets a landscape adaptive banner ad size.
116+
/// </summary>
117+
/// <param name="width">The width of the ad in density-independent pixels.</param>
118+
/// <returns>A landscape adaptive banner ad size.</returns>
111119
public static AdSize GetLandscapeAnchoredAdaptiveBannerAdSizeWithWidth(int width)
112120
{
113121
return CreateAnchoredAdaptiveAdSize(width, Orientation.Landscape);
114122
}
115123

124+
/// <summary>
125+
/// Gets a portrait adaptive banner ad size.
126+
/// </summary>
127+
/// <param name="width">The width of the ad in density-independent pixels.</param>
128+
/// <returns>A portrait adaptive banner ad size.</returns>
116129
public static AdSize GetPortraitAnchoredAdaptiveBannerAdSizeWithWidth(int width)
117130
{
118131
return CreateAnchoredAdaptiveAdSize(width, Orientation.Portrait);
119132
}
120133

134+
/// <summary>
135+
/// Gets a current orientation adaptive banner ad size.
136+
/// </summary>
137+
/// <param name="width">The width of the ad in density-independent pixels.</param>
138+
/// <returns>A current orientation adaptive banner ad size.</returns>
121139
public static AdSize GetCurrentOrientationAnchoredAdaptiveBannerAdSizeWithWidth(int width)
122140
{
123141
return CreateAnchoredAdaptiveAdSize(width, Orientation.Current);
@@ -167,6 +185,9 @@ internal Orientation Orientation
167185
}
168186
}
169187

188+
/// <summary>
189+
/// Returns whether the <see cref="AdSize"/> objects are equal.
190+
/// </summary>
170191
public override bool Equals(object obj)
171192
{
172193
if (obj == null || GetType() != obj.GetType())
@@ -179,6 +200,12 @@ public override bool Equals(object obj)
179200
&& (_type == other._type) && (_orientation == other._orientation);
180201
}
181202

203+
/// <summary>
204+
/// Returns whether the <see cref="AdSize"/> objects are equal.
205+
/// </summary>
206+
/// <param name="a">The first <see cref="AdSize"/> object.</param>
207+
/// <param name="b">The second <see cref="AdSize"/> object.</param>
208+
/// <returns>True if the <see cref="AdSize"/> objects are equal.</returns>
182209
public static bool operator ==(AdSize a, AdSize b)
183210
{
184211
if ((object)a == null)
@@ -189,6 +216,12 @@ public override bool Equals(object obj)
189216
return a.Equals(b);
190217
}
191218

219+
/// <summary>
220+
/// Returns whether the <see cref="AdSize"/> objects are not equal.
221+
/// </summary>
222+
/// <param name="a">The first <see cref="AdSize"/> object.</param>
223+
/// <param name="b">The second <see cref="AdSize"/> object.</param>
224+
/// <returns>True if the <see cref="AdSize"/> objects are not equal.</returns>
192225
public static bool operator !=(AdSize a, AdSize b)
193226
{
194227
if ((object)a == null)
@@ -199,6 +232,9 @@ public override bool Equals(object obj)
199232
return !a.Equals(b);
200233
}
201234

235+
/// <summary>
236+
/// Returns the hash code.
237+
/// </summary>
202238
public override int GetHashCode()
203239
{
204240
int hashBase = 71;

source/plugin/Assets/GoogleMobileAds/Api/Core/NativeTemplateStyle.cs

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -43,36 +43,43 @@ public class NativeTemplateStyle
4343
public string TemplateId;
4444

4545
/// <summary>
46-
// The background color.
46+
/// The background color.
4747
/// </summary>
4848
public Color MainBackgroundColor;
4949

5050
/// <summary>
51-
// The NativeTemplateTextStyle for the primary text.
51+
/// The NativeTemplateTextStyle for the primary text.
5252
/// </summary>
5353
public NativeTemplateTextStyle PrimaryText;
5454

5555
/// <summary>
5656
/// The NativeTemplateTextStyle for the second row of text in the template.
57-
/// <summary>
57+
/// </summary>
5858
public NativeTemplateTextStyle SecondaryText;
5959

6060
/// <summary>
6161
/// The NativeTemplateTextStyle for the third row of text in the template.
62-
/// <summary>
62+
/// </summary>
6363
public NativeTemplateTextStyle TertiaryText;
6464

6565
/// <summary>
6666
/// The NativeTemplateTextStyle for the call to action.
67-
/// <summary>
67+
/// </summary>
6868
public NativeTemplateTextStyle CallToActionText;
6969

70+
/// <summary>
71+
/// Creates a <see cref="NativeTemplateStyle"/> using the Small Template<see cref="TemplateId"/>.
72+
/// </summary>
7073
public NativeTemplateStyle()
7174
{
7275
// Default to using the small template.
7376
TemplateId = NativeTemplateId.Small;
7477
}
7578

79+
/// <summary>
80+
/// Creates a <see cref="NativeTemplateStyle"/> from a given <see cref="NativeTemplateStyle"/>.
81+
/// </summary>
82+
/// <param name="templateStyle">The <see cref="NativeTemplateStyle"/> parameter to copy.</param>
7683
public NativeTemplateStyle(NativeTemplateStyle templateStyle)
7784
{
7885
TemplateId = templateStyle.TemplateId;

source/plugin/Assets/GoogleMobileAds/Api/Core/PreloadConfiguration.cs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,10 @@ public sealed class PreloadConfiguration
4545

4646
public PreloadConfiguration() { }
4747

48+
/// <summary>
49+
/// Creates a <see cref="PreloadConfiguration"/> from a given <see cref="PreloadConfiguration"/>.
50+
/// </summary>
51+
/// <param name="configuration">The <see cref="PreloadConfiguration"/> parameter to copy.</param>
4852
public PreloadConfiguration(PreloadConfiguration configuration)
4953
{
5054
AdUnitId = configuration.AdUnitId;

source/plugin/Assets/GoogleMobileAds/Api/Core/RequestConfiguration.cs

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@ public class RequestConfiguration
3232
/// <summary>
3333
/// This property allows you to specify whether you would like your app to be treated as
3434
/// child-directed for purposes of the Children’s Online Privacy Protection Act (COPPA) -
35-
/// <seealso href="http://business.ftc.gov/privacy-and-security/childrens-privacy">
36-
/// http://business.ftc.gov/privacy-and-security/childrens-privacy</seealso>.
35+
/// <a href="http://business.ftc.gov/privacy-and-security/childrens-privacy">
36+
/// http://business.ftc.gov/privacy-and-security/childrens-privacy</a>.
3737
///
3838
/// If you set this property to True, you will
3939
/// indicate that your app should be treated as child-directed for purposes of the Children’s
@@ -50,7 +50,7 @@ public class RequestConfiguration
5050
/// authorized to act on behalf of the owner of the app. You understand that abuse of this
5151
/// setting may result in termination of your Google account.
5252
/// </summary>
53-
/// </remarks>
53+
/// <remarks>
5454
/// Note: it may take some time for this designation to be fully implemented in applicable
5555
/// Google services.
5656
/// </remarks>
@@ -83,6 +83,10 @@ public class RequestConfiguration
8383

8484
public RequestConfiguration() {}
8585

86+
/// <summary>
87+
/// Creates a <see cref="RequestConfiguration"/> from a given <see cref="RequestConfiguration"/>.
88+
/// </summary>
89+
/// <param name="requestConfiguration">The <see cref="RequestConfiguration"/> parameter to copy.</param>
8690
public RequestConfiguration(RequestConfiguration requestConfiguration)
8791
{
8892
MaxAdContentRating = requestConfiguration.MaxAdContentRating;

source/plugin/Assets/GoogleMobileAds/Api/Core/Reward.cs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,10 @@ public class Reward : EventArgs
3535

3636
public Reward() {}
3737

38+
/// <summary>
39+
/// Creates a <see cref="Reward"/> from a given <see cref="Reward"/>.
40+
/// </summary>
41+
/// <param name="reward">The <see cref="Reward"/> parameter to copy.</param>
3842
public Reward(Reward reward)
3943
{
4044
Type = reward.Type;

source/plugin/Assets/GoogleMobileAds/Api/Core/ServerSideVerificationOptions.cs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,10 @@ public class ServerSideVerificationOptions
3535

3636
public ServerSideVerificationOptions() {}
3737

38+
/// <summary>
39+
/// Creates a <see cref="ServerSideVerificationOptions"/> from a given <see cref="ServerSideVerificationOptions"/>.
40+
/// </summary>
41+
/// <param name="options">The <see cref="ServerSideVerificationOptions"/> parameter to copy.</param>
3842
public ServerSideVerificationOptions(ServerSideVerificationOptions options)
3943
{
4044
UserId = options.UserId;

0 commit comments

Comments
 (0)