Skip to content

Commit c4db163

Browse files
author
Bart Koelman
committed
Fixed broken links in doc-comments
1 parent 911633e commit c4db163

File tree

4 files changed

+19
-20
lines changed

4 files changed

+19
-20
lines changed

src/JsonApiDotNetCore.Annotations/Configuration/ResourceType.cs

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -48,27 +48,27 @@ public sealed class ResourceType
4848
public IReadOnlyCollection<EagerLoadAttribute> EagerLoads { get; }
4949

5050
/// <summary>
51-
/// Configures which links to show in the <see cref="Serialization.Objects.TopLevelLinks" /> object for this resource type. Defaults to
52-
/// <see cref="LinkTypes.NotConfigured" />, which falls back to <see cref="IJsonApiOptions.TopLevelLinks" />.
51+
/// Configures which links to write in the top-level links object for this resource type. Defaults to <see cref="LinkTypes.NotConfigured" />, which falls
52+
/// back to TopLevelLinks in global options.
5353
/// </summary>
5454
/// <remarks>
5555
/// In the process of building the resource graph, this value is set based on <see cref="ResourceLinksAttribute.TopLevelLinks" /> usage.
5656
/// </remarks>
5757
public LinkTypes TopLevelLinks { get; }
5858

5959
/// <summary>
60-
/// Configures which links to show in the <see cref="Serialization.Objects.ResourceLinks" /> object for this resource type. Defaults to
61-
/// <see cref="LinkTypes.NotConfigured" />, which falls back to <see cref="IJsonApiOptions.ResourceLinks" />.
60+
/// Configures which links to write in the resource-level links object for this resource type. Defaults to <see cref="LinkTypes.NotConfigured" />, which
61+
/// falls back to ResourceLinks in global options.
6262
/// </summary>
6363
/// <remarks>
6464
/// In the process of building the resource graph, this value is set based on <see cref="ResourceLinksAttribute.ResourceLinks" /> usage.
6565
/// </remarks>
6666
public LinkTypes ResourceLinks { get; }
6767

6868
/// <summary>
69-
/// Configures which links to show in the <see cref="Serialization.Objects.RelationshipLinks" /> object for all relationships of this resource type.
70-
/// Defaults to <see cref="LinkTypes.NotConfigured" />, which falls back to <see cref="IJsonApiOptions.RelationshipLinks" />. This can be overruled per
71-
/// relationship by setting <see cref="RelationshipAttribute.Links" />.
69+
/// Configures which links to write in the relationship-level links object for all relationships of this resource type. Defaults to
70+
/// <see cref="LinkTypes.NotConfigured" />, which falls back to RelationshipLinks in global options. This can be overruled per relationship by setting
71+
/// <see cref="RelationshipAttribute.Links" />.
7272
/// </summary>
7373
/// <remarks>
7474
/// In the process of building the resource graph, this value is set based on <see cref="ResourceLinksAttribute.RelationshipLinks" /> usage.

src/JsonApiDotNetCore.Annotations/Resources/Annotations/RelationshipAttribute.cs

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -63,9 +63,8 @@ public abstract class RelationshipAttribute : ResourceFieldAttribute
6363
public ResourceType RightType { get; internal set; } = null!;
6464

6565
/// <summary>
66-
/// Configures which links to show in the <see cref="Serialization.Objects.RelationshipLinks" /> object for this relationship. Defaults to
67-
/// <see cref="LinkTypes.NotConfigured" />, which falls back to <see cref="ResourceLinksAttribute.RelationshipLinks" /> and then falls back to
68-
/// <see cref="IJsonApiOptions.RelationshipLinks" />.
66+
/// Configures which links to write in the relationship-level links object for this relationship. Defaults to <see cref="LinkTypes.NotConfigured" />,
67+
/// which falls back to <see cref="ResourceLinksAttribute.RelationshipLinks" /> and then falls back to RelationshipLinks in global options.
6968
/// </summary>
7069
public LinkTypes Links { get; set; } = LinkTypes.NotConfigured;
7170

src/JsonApiDotNetCore.Annotations/Resources/Annotations/ResourceLinksAttribute.cs

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,21 +10,21 @@ namespace JsonApiDotNetCore.Resources.Annotations;
1010
public sealed class ResourceLinksAttribute : Attribute
1111
{
1212
/// <summary>
13-
/// Configures which links to show in the <see cref="Serialization.Objects.TopLevelLinks" /> object for this resource type. Defaults to
14-
/// <see cref="LinkTypes.NotConfigured" />, which falls back to <see cref="IJsonApiOptions.TopLevelLinks" />.
13+
/// Configures which links to write in the top-level links object for this resource type. Defaults to <see cref="LinkTypes.NotConfigured" />, which falls
14+
/// back to TopLevelLinks in global options.
1515
/// </summary>
1616
public LinkTypes TopLevelLinks { get; set; } = LinkTypes.NotConfigured;
1717

1818
/// <summary>
19-
/// Configures which links to show in the <see cref="Serialization.Objects.ResourceLinks" /> object for this resource type. Defaults to
20-
/// <see cref="LinkTypes.NotConfigured" />, which falls back to <see cref="IJsonApiOptions.ResourceLinks" />.
19+
/// Configures which links to write in the resource-level links object for this resource type. Defaults to <see cref="LinkTypes.NotConfigured" />, which
20+
/// falls back to ResourceLinks in global options.
2121
/// </summary>
2222
public LinkTypes ResourceLinks { get; set; } = LinkTypes.NotConfigured;
2323

2424
/// <summary>
25-
/// Configures which links to show in the <see cref="Serialization.Objects.RelationshipLinks" /> object for all relationships of this resource type.
26-
/// Defaults to <see cref="LinkTypes.NotConfigured" />, which falls back to <see cref="IJsonApiOptions.RelationshipLinks" />. This can be overruled per
27-
/// relationship by setting <see cref="RelationshipAttribute.Links" />.
25+
/// Configures which links to write in the relationship-level links object for all relationships of this resource type. Defaults to
26+
/// <see cref="LinkTypes.NotConfigured" />, which falls back to RelationshipLinks in global options. This can be overruled per relationship by setting
27+
/// <see cref="RelationshipAttribute.Links" />.
2828
/// </summary>
2929
public LinkTypes RelationshipLinks { get; set; } = LinkTypes.NotConfigured;
3030
}

src/JsonApiDotNetCore/Configuration/IJsonApiOptions.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -63,19 +63,19 @@ public interface IJsonApiOptions
6363
bool UseRelativeLinks { get; }
6464

6565
/// <summary>
66-
/// Configures which links to show in the <see cref="Serialization.Objects.TopLevelLinks" /> object. Defaults to <see cref="LinkTypes.All" />. This
66+
/// Configures which links to write in the <see cref="Serialization.Objects.TopLevelLinks" /> object. Defaults to <see cref="LinkTypes.All" />. This
6767
/// setting can be overruled per resource type by adding <see cref="ResourceLinksAttribute" /> on the class definition of a resource.
6868
/// </summary>
6969
LinkTypes TopLevelLinks { get; }
7070

7171
/// <summary>
72-
/// Configures which links to show in the <see cref="Serialization.Objects.ResourceLinks" /> object. Defaults to <see cref="LinkTypes.All" />. This
72+
/// Configures which links to write in the <see cref="Serialization.Objects.ResourceLinks" /> object. Defaults to <see cref="LinkTypes.All" />. This
7373
/// setting can be overruled per resource type by adding <see cref="ResourceLinksAttribute" /> on the class definition of a resource.
7474
/// </summary>
7575
LinkTypes ResourceLinks { get; }
7676

7777
/// <summary>
78-
/// Configures which links to show in the <see cref="Serialization.Objects.RelationshipLinks" /> object. Defaults to <see cref="LinkTypes.All" />. This
78+
/// Configures which links to write in the <see cref="Serialization.Objects.RelationshipLinks" /> object. Defaults to <see cref="LinkTypes.All" />. This
7979
/// setting can be overruled for all relationships per resource type by adding <see cref="ResourceLinksAttribute" /> on the class definition of a
8080
/// resource. This can be further overruled per relationship by setting <see cref="RelationshipAttribute.Links" />.
8181
/// </summary>

0 commit comments

Comments
 (0)