Skip to content

Commit 94c1e42

Browse files
Fix doc links
1 parent 581046a commit 94c1e42

File tree

2 files changed

+12
-11
lines changed

2 files changed

+12
-11
lines changed

Makefile

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,8 @@ pack: build
5454
push:
5555
dotnet nuget push $(ARTIFACT_PATH)/*.nupkg -s $(NUGET_SOURCE) -k $(NUGET_API_KEY)
5656

57-
generate-docs: build
57+
generate-docs: restore
58+
dotnet build -c Release
5859
dotnet docfx $(DOCS_PATH)/docfx.json --warningsAsErrors true
5960

6061
serve-docs: generate-docs

docs/shape-providers.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -172,9 +172,9 @@ For example, serializers may need to jump from a type shape to its converter.
172172

173173
[!code-csharp[](CSharpSamples/AssociatedTypes.cs#TypeShapeOneType)]
174174

175-
Use the @PolyType.ITypeShape.GetAssociatedTypeShape*?displayProperty=nameWithType method to obtain the shape of an associated type.
176-
The @PolyType.SourceGenModel.SourceGenTypeShapeProvider implementation of this method requires that the associated types be pre-determined at compile time via attributes.
177-
The @PolyType.ReflectionProvider.ReflectionTypeShapeProvider is guaranteed to work with all types and therefore does _not_ require these attributes.
175+
Use the <xref:PolyType.ITypeShape.GetAssociatedTypeShape*> method to obtain the shape of an associated type.
176+
The <xref:PolyType.SourceGenModel.SourceGenTypeShapeProvider> implementation of this method requires that the associated types be pre-determined at compile time via attributes.
177+
The <xref:PolyType.ReflectionProvider.ReflectionTypeShapeProvider> is guaranteed to work with all types and therefore does _not_ require these attributes.
178178
Thus, it can be valuable to test your associated types code with the source generation provider to ensure your code is AOT-compatible.
179179

180180
An associated type must have at least `internal` visibility for its shape to be generated for use within its same assembly.
@@ -190,20 +190,20 @@ This can be appropriate for a serializer that needs to jump from a generic data
190190

191191
[!code-csharp[](CSharpSamples/AssociatedTypes.cs#SerializerConverter)]
192192

193-
Only @PolyType.SourceGenModel.SourceGenTypeShapeProvider produces partial shapes.
194-
The @PolyType.ReflectionProvider.ReflectionTypeShapeProvider always produces complete shapes.
193+
Only <xref:PolyType.SourceGenModel.SourceGenTypeShapeProvider> produces partial shapes.
194+
The <xref:PolyType.ReflectionProvider.ReflectionTypeShapeProvider> always produces complete shapes.
195195

196-
At present, only @PolyType.Abstractions.IObjectTypeShape shapes are generated partially.
196+
At present, only <xref:PolyType.Abstractions.IObjectTypeShape> shapes are generated partially.
197197
Shapes for collections, enums, unions, etc. are generated as full shapes.
198198

199-
Type associations can be defined directly on the originating type via @PolyType.AssociatedTypeShapeAttribute.AssociatedTypes?displayProperty=nameWithType when that type and its associated type are in the same assembly.
200-
When the associated type is in another assembly, use @PolyType.TypeShapeExtensionAttribute.AssociatedTypes?displayProperty=nameWithType in the assembly that declares the associated type.
199+
Type associations can be defined directly on the originating type via <xref:PolyType.AssociatedTypeShapeAttribute.AssociatedTypes> when that type and its associated type are in the same assembly.
200+
When the associated type is in another assembly, use <xref:PolyType.TypeShapeExtensionAttribute.AssociatedTypes> in the assembly that declares the associated type.
201201
You can also define a custom attribute that can define associated types by attributing your own custom attribute with @PolyType.Abstractions.AssociatedTypeAttributeAttribute.
202202

203203
### TypeShapeExtensionAttribute
204204

205-
The @PolyType.TypeShapeExtensionAttribute is an assembly-level attribute.
206-
It is very similar to @PolyType.TypeShapeAttribute, but it is used to customize the generated shape for a type that your assembly does not declare.
205+
The <xref:PolyType.TypeShapeExtensionAttribute> is an assembly-level attribute.
206+
It is very similar to <xref:PolyType.TypeShapeAttribute>, but it is used to customize the generated shape for a type that your assembly does not declare.
207207

208208
### Polymorphic types
209209

0 commit comments

Comments
 (0)