Skip to content

Commit 15e5683

Browse files
authored
Merge pull request #68 from firebase/hkj-api-docs
Changed <see href> tags to <a tags> in API docs
2 parents b54e7ea + 6711140 commit 15e5683

File tree

6 files changed

+14
-13
lines changed

6 files changed

+14
-13
lines changed

FirebaseAdmin/FirebaseAdmin/Messaging/ApnsConfig.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ namespace FirebaseAdmin.Messaging
2222
{
2323
/// <summary>
2424
/// Represents the APNS-specific options that can be included in a <see cref="Message"/>. Refer
25-
/// to <see href="https://developer.apple.com/library/content/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/APNSOverview.html">
26-
/// APNs documentation</see> for various headers and payload fields supported by APNS.
25+
/// to <a href="https://developer.apple.com/library/content/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/APNSOverview.html">
26+
/// APNs documentation</a> for various headers and payload fields supported by APNS.
2727
/// </summary>
2828
public sealed class ApnsConfig
2929
{

FirebaseAdmin/FirebaseAdmin/Messaging/Aps.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@
2121
namespace FirebaseAdmin.Messaging
2222
{
2323
/// <summary>
24-
/// Represents the <see href="https://developer.apple.com/library/content/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/PayloadKeyReference.html">
25-
/// aps dictionary</see> that is part of every APNs message.
24+
/// Represents the <a href="https://developer.apple.com/library/content/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/PayloadKeyReference.html">
25+
/// aps dictionary</a> that is part of every APNs message.
2626
/// </summary>
2727
public sealed class Aps
2828
{

FirebaseAdmin/FirebaseAdmin/Messaging/ApsAlert.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@
2020
namespace FirebaseAdmin.Messaging
2121
{
2222
/// <summary>
23-
/// Represents the <see href="https://developer.apple.com/library/content/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/PayloadKeyReference.html#//apple_ref/doc/uid/TP40008194-CH17-SW5">
24-
/// alert property</see> that can be included in the <c>aps</c> dictionary of an APNs
23+
/// Represents the <a href="https://developer.apple.com/library/content/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/PayloadKeyReference.html#//apple_ref/doc/uid/TP40008194-CH17-SW5">
24+
/// alert property</a> that can be included in the <c>aps</c> dictionary of an APNs
2525
/// payload.
2626
/// </summary>
2727
public sealed class ApsAlert

FirebaseAdmin/FirebaseAdmin/Messaging/WebpushConfig.cs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@ public sealed class WebpushConfig
2525
{
2626
/// <summary>
2727
/// Gets or sets the Webpush HTTP headers. Refer
28-
/// <see href="https://tools.ietf.org/html/rfc8030#section-5">
29-
/// Webpush specification</see> for supported headers.
28+
/// <a href="https://tools.ietf.org/html/rfc8030#section-5">
29+
/// Webpush specification</a> for supported headers.
3030
/// </summary>
3131
[JsonProperty("headers")]
3232
public IReadOnlyDictionary<string, string> Headers { get; set; }
@@ -39,13 +39,13 @@ public sealed class WebpushConfig
3939
public IReadOnlyDictionary<string, string> Data { get; set; }
4040

4141
/// <summary>
42-
/// Gets or sets the Webpush notification that will be included in the message.
42+
/// Gets or sets the Webpush notification included in the message.
4343
/// </summary>
4444
[JsonProperty("notification")]
4545
public WebpushNotification Notification { get; set; }
4646

4747
/// <summary>
48-
/// Gets or sets the Webpush options that will be included in the message.
48+
/// Gets or sets the Webpush options included in the message.
4949
/// </summary>
5050
[JsonProperty("fcm_options")]
5151
public WebpushFcmOptions FcmOptions { get; set; }

FirebaseAdmin/FirebaseAdmin/Messaging/WebpushFcmOptions.cs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,8 @@ namespace FirebaseAdmin.Messaging
1919
{
2020
/// <summary>
2121
/// Represents the Webpush-specific notification options that can be included in a <see cref="Message"/>.
22-
/// See <see href="https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#WebpushFcmOptions">this link</see>.
22+
/// See <a href="https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#WebpushFcmOptions">REST
23+
/// API reference</a> for a list of supported fields.
2324
/// </summary>
2425
public sealed class WebpushFcmOptions
2526
{

FirebaseAdmin/FirebaseAdmin/Messaging/WebpushNotification.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@ namespace FirebaseAdmin.Messaging
2323
/// <summary>
2424
/// Represents the Webpush-specific notification options that can be included in a
2525
/// <see cref="Message"/>. Supports most standard options defined in the
26-
/// <see href="https://developer.mozilla.org/en-US/docs/Web/API/notification/Notification">
27-
/// Web Notification specification</see>.
26+
/// <a href="https://developer.mozilla.org/en-US/docs/Web/API/notification/Notification">
27+
/// Web Notification specification</a>.
2828
/// </summary>
2929
public sealed class WebpushNotification
3030
{

0 commit comments

Comments
 (0)