Skip to content

Commit a6b9305

Browse files
author
Bart Koelman
authored
Added auto-expansion of inheritdoc comments (#947)
* Added auto-expansion of inheritdoc comments using https://github.com/saucecontrol/InheritDoc, so that VS Intellisense picks it up when consumed as package reference. * Empty commit to retrigger cibuild
1 parent 04ba8b1 commit a6b9305

File tree

3 files changed

+10
-2
lines changed

3 files changed

+10
-2
lines changed

Diff for: src/JsonApiDotNetCore/Controllers/JsonApiCommandController.cs

+3-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,9 @@ namespace JsonApiDotNetCore.Controllers
1818
/// <typeparam name="TId">The resource identifier type.</typeparam>
1919
public abstract class JsonApiCommandController<TResource, TId> : BaseJsonApiController<TResource, TId> where TResource : class, IIdentifiable<TId>
2020
{
21-
/// <inheritdoc />
21+
/// <summary>
22+
/// Creates an instance from a write-only service.
23+
/// </summary>
2224
protected JsonApiCommandController(
2325
IJsonApiOptions options,
2426
ILoggerFactory loggerFactory,

Diff for: src/JsonApiDotNetCore/Controllers/JsonApiQueryController.cs

+3-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,9 @@ namespace JsonApiDotNetCore.Controllers
1717
/// <typeparam name="TId">The resource identifier type.</typeparam>
1818
public abstract class JsonApiQueryController<TResource, TId> : BaseJsonApiController<TResource, TId> where TResource : class, IIdentifiable<TId>
1919
{
20-
/// <inheritdoc />
20+
/// <summary>
21+
/// Creates an instance from a read-only service.
22+
/// </summary>
2123
protected JsonApiQueryController(
2224
IJsonApiOptions context,
2325
ILoggerFactory loggerFactory,

Diff for: src/JsonApiDotNetCore/JsonApiDotNetCore.csproj

+4
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,10 @@
2626
<PackageReference Include="Microsoft.EntityFrameworkCore" Version="3.1.0" />
2727
<PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.0.0" PrivateAssets="All" />
2828
<PackageReference Include="Newtonsoft.Json" Version="12.0.3" />
29+
<PackageReference Include="SauceControl.InheritDoc" Version="1.2.0">
30+
<PrivateAssets>all</PrivateAssets>
31+
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
32+
</PackageReference>
2933
<PackageReference Include="System.ValueTuple" Version="4.5.0" />
3034
</ItemGroup>
3135
</Project>

0 commit comments

Comments
 (0)