Skip to content

Commit 3b58699

Browse files
committed
add description and usage
1 parent ef7c40b commit 3b58699

File tree

1 file changed

+40
-2
lines changed

1 file changed

+40
-2
lines changed

README.md

Lines changed: 40 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,48 @@
11
[![GitHub license](https://img.shields.io/github/license/smdn/Smdn.Reflection.ReverseGenerating)](https://github.com/smdn/Smdn.Reflection.ReverseGenerating/blob/main/LICENSE.txt)
22

3-
# `GenerateApiList` MSBuild task
3+
# Smdn.Reflection.ReverseGenerating.ListApi.MSBuild.Tasks
44
[![NuGet Smdn.Reflection.ReverseGenerating.ListApi.MSBuild.Tasks](https://img.shields.io/nuget/v/Smdn.Reflection.ReverseGenerating.ListApi.MSBuild.Tasks.svg)](https://www.nuget.org/packages/Smdn.Reflection.ReverseGenerating.ListApi.MSBuild.Tasks/)
55

6-
# `list-api`
6+
This package provides `GenerateApiList` MSBuild task.
7+
8+
## Usage
9+
```xml
10+
<ItemGroup>
11+
<!-- Add package reference of Smdn.Reflection.ReverseGenerating.ListApi.MSBuild.Tasks. -->
12+
<PackageReference
13+
Include="Smdn.Reflection.ReverseGenerating.ListApi.MSBuild.Tasks"
14+
Version="1.0.3"
15+
PrivateAssets="all"
16+
IncludeAssets="build"
17+
/>
18+
</ItemGroup>
19+
20+
<ItemGroup>
21+
<!-- Specify target assemblies to generate API list. -->
22+
<GenerateApiListTargetAssemblies Include="..." />
23+
</ItemGroup>
24+
25+
<PropertyGroup>
26+
<!-- (Optional) If you want to import 'Smdn.Reflection.ReverseGenerating.ListApi.MSBuild.Tasks.targets' even if the build target is `pack`. -->
27+
<ExcludeRestorePackageImports>false</ExcludeRestorePackageImports>
28+
</PropertyGroup>
29+
30+
<Target Name="GenerateApiListFromAssemblies" AfterTargets="Pack">
31+
<!-- Call `GenerateApiList` task -->
32+
<GenerateApiList Assemblies="@(GenerateApiListTargetAssemblies)">
33+
<Output TaskParameter="GeneratedFiles" ItemName="GeneratedApiListFiles" />
34+
</GenerateApiList>
35+
36+
<Message Text="generated API list: @(GeneratedApiListFiles)" Importance="high" />
37+
</Target>
38+
```
39+
40+
# Smdn.Reflection.ReverseGenerating.ListApi
741
[![NuGet Smdn.Reflection.ReverseGenerating.ListApi](https://img.shields.io/nuget/v/Smdn.Reflection.ReverseGenerating.ListApi.svg)](https://www.nuget.org/packages/Smdn.Reflection.ReverseGenerating.ListApi/)
842

43+
This package provides `list-api` command line tool.
44+
45+
This tool does not provide any code-formatting options.
46+
947
# Smdn.Reflection.ReverseGenerating
1048
[![NuGet Smdn.Reflection.ReverseGenerating](https://img.shields.io/nuget/v/Smdn.Reflection.ReverseGenerating.svg)](https://www.nuget.org/packages/Smdn.Reflection.ReverseGenerating/)

0 commit comments

Comments
 (0)