Summary.Roslyn 0.0.3

.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher.
There is a newer prerelease version of this package available.
See the version list below for details. 
dotnet add package Summary.Roslyn --version 0.0.3
                    


                    

                
NuGet\Install-Package Summary.Roslyn -Version 0.0.3
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="Summary.Roslyn" Version="0.0.3" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="Summary.Roslyn" Version="0.0.3" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="Summary.Roslyn" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add Summary.Roslyn --version 0.0.3
                    


                    

                
#r "nuget: Summary.Roslyn, 0.0.3"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#:package Summary.Roslyn@0.0.3
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=Summary.Roslyn&version=0.0.3
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=Summary.Roslyn&version=0.0.3
                    


                            Install as a Cake Tool

<div align="center"> <img src="./res/icon-512.png" alt="Logo" width="128" height="128"></img> </div>

<h1 align="center"><summary></h1>

<p align="center"> <i>Flexible and effortless API reference generator for .NET.</i> </p>

<p align="center"> <img alt="Nuget" src="https://img.shields.io/nuget/v/Summary"> </p>

Usage

Currently, the generator is pretty young. In order to use it, you should download Summary (Core), Summary.Roslyn (Parser) and Summary.Markdown (Renderer) packages.

Here is a simple code-snippet that parses files in the specified directory and renders them into Markdown format:

// The folder you want to parse the `*.cs` files from.
const string input = "./src";

// The folder you want to put the generator output into.
const string output = "./docs";

await new SummaryPipeline()
    .UseRoslynParser(input)
    .UseMdRenderer(output)
    .Run();

Examples

Consider checking out the docs directory: it's the Summary summary generated by Summary. 🌞

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
0.0.4-dev202312201641 239 12/20/2023
0.0.4-dev202312191726 190 12/19/2023
0.0.4-dev202312171234 207 12/17/2023
0.0.4-dev202312142139 197 12/14/2023
0.0.4-dev202312142136 191 12/14/2023
0.0.4-dev202312142118 198 12/14/2023
0.0.4-dev202312102326 212 12/10/2023
0.0.4-dev202312102321 192 12/10/2023
0.0.4-dev202312102141 204 12/10/2023
0.0.4-dev202312102139 210 12/10/2023
0.0.4-dev202312102119 194 12/10/2023
0.0.4-dev202312102117 194 12/10/2023
0.0.4-dev202312101851 208 12/10/2023
0.0.4-dev202312101817 190 12/10/2023
0.0.4-dev202312101658 202 12/10/2023
0.0.4-dev202312101307 204 12/10/2023
0.0.4-dev202312100027 206 12/10/2023
0.0.4-dev202312092222 190 12/9/2023
0.0.4-dev202312092221 202 12/9/2023
0.0.3 282 11/26/2023
Loading failed