Skip to content
This repository was archived by the owner on Dec 12, 2020. It is now read-only.

Commit c5fe1b7

Browse files
committed
docs: Updated project/package descriptions
1 parent 3cc66ad commit c5fe1b7

6 files changed

Lines changed: 27 additions & 6 deletions

File tree

src/CodeGeneration.Roslyn.Attributes/CodeGeneration.Roslyn.Attributes.csproj

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,9 @@
33
<PropertyGroup>
44
<TargetFrameworks>net20;net40;netstandard1.0</TargetFrameworks>
55
<RootNamespace>CodeGeneration.Roslyn</RootNamespace>
6-
<Description>A package that offers attributes to drive code generation.</Description>
6+
<Description>A package that offers attributes to drive code generation. API:
7+
* CodeGeneration.Roslyn.CodeGenerationAttributeAttribute
8+
</Description>
79
</PropertyGroup>
810

911
</Project>

src/CodeGeneration.Roslyn.Engine/CodeGeneration.Roslyn.Engine.csproj

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,10 @@
22

33
<PropertyGroup>
44
<TargetFramework>netcoreapp2.0</TargetFramework>
5-
<Description>The engine of source code generation used by CodeGeneration.Roslyn.Tool.</Description>
5+
<Description>The engine of source code generation; used by CodeGeneration.Roslyn.Tool. Useful for testing custom source generators. API:
6+
* CodeGeneration.Roslyn.CompilationGenerator
7+
* CodeGeneration.Roslyn.DocumentTransform
8+
</Description>
69
</PropertyGroup>
710

811
<ItemGroup>

src/CodeGeneration.Roslyn.Plugin.Sdk/CodeGeneration.Roslyn.Plugin.Sdk.csproj

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,12 @@
22

33
<PropertyGroup>
44
<TargetFramework>netstandard1.0</TargetFramework>
5-
<Description>The MSBuild SDK that helps correctly create CodeGeneration.Roslyn plugins.</Description>
5+
<Description>The MSBuild project SDK that helps correctly create CodeGeneration.Roslyn plugins (generators).
6+
7+
For the convenience of plugin consumers, create metapackage as well. For details, see project readme: https://github.com/AArnott/CodeGeneration.Roslyn#package-your-code-generator
8+
9+
How to use MSBuild project SDKs: https://docs.microsoft.com/visualstudio/msbuild/how-to-use-project-sdk
10+
</Description>
611
<GeneratePackageOnBuild>true</GeneratePackageOnBuild>
712
<DevelopmentDependency>true</DevelopmentDependency>
813
<SymbolPackageFormat></SymbolPackageFormat>

src/CodeGeneration.Roslyn.PluginMetapackage.Sdk/CodeGeneration.Roslyn.PluginMetapackage.Sdk.csproj

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,12 @@
22

33
<PropertyGroup>
44
<TargetFramework>netstandard1.0</TargetFramework>
5-
<Description>The MSBuild SDK that helps correctly create CodeGeneration.Roslyn plugins.</Description>
5+
<Description>The MSBuild project SDK that helps correctly create metapackage for CodeGeneration.Roslyn plugins (generators).
6+
7+
Metapackages are created for the convenience of plugin consumers. For details, see project readme: https://github.com/AArnott/CodeGeneration.Roslyn#package-your-code-generator
8+
9+
How to use MSBuild project SDKs: https://docs.microsoft.com/visualstudio/msbuild/how-to-use-project-sdk
10+
</Description>
611
<GeneratePackageOnBuild>true</GeneratePackageOnBuild>
712
<DevelopmentDependency>true</DevelopmentDependency>
813
<SymbolPackageFormat></SymbolPackageFormat>

src/CodeGeneration.Roslyn.Tool/CodeGeneration.Roslyn.Tool.csproj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<PropertyGroup>
44
<OutputType>Exe</OutputType>
55
<TargetFramework>netcoreapp2.1</TargetFramework>
6-
<Description>The dotnet code generation tool that works with the CodeGeneration.Roslyn nuget package.</Description>
6+
<Description>Source code generation tool that hosts custom generators (AKA Plugins). This package contains MSBuild targets that run the tool during a build, before compilation. See project site for details.</Description>
77
<CodeAnalysisRuleSet>CodeGeneration.Roslyn.Tool.ruleset</CodeAnalysisRuleSet>
88
<!-- Run on future runtimes - as a build tool, let's be user friendly. -->
99
<RollForward>Major</RollForward>

src/CodeGeneration.Roslyn/CodeGeneration.Roslyn.csproj

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,13 @@
22

33
<PropertyGroup>
44
<TargetFramework>netstandard2.0</TargetFramework>
5-
<Description>A package that offers libraries for creating a code generation attribute and the associated generator.</Description>
5+
<Description>Library for creating source generators. API (types contained):
6+
* CodeGeneration.Roslyn.ICodeGenerator
7+
* CodeGeneration.Roslyn.IRichCodeGenerator
8+
* CodeGeneration.Roslyn.Logger
9+
* CodeGeneration.Roslyn.RichGenerationResult
10+
* CodeGeneration.Roslyn.TransformationContext
11+
</Description>
612
</PropertyGroup>
713

814
<ItemGroup>

0 commit comments

Comments
 (0)